apero_wave_night_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: WAVE

Nightly wavelength solution calibration¶

Considering that the wavelength solution is central in the anchoring of PRV measurement and that the instrument will drift through time, one needs to obtain a wavelength solution as close as possible in time to the science exposures, ideally on a nightly basis. The nightly wavelength solution captures sub-\(\mu m\) level motions within the optical train and high-order changes in the focal plane that are not captured by the affine transform used to register frames as described in sections ref{subsec:ref_shape} and ref{subsec:night_shape}. The nightly wavelength solution recipe takes preprocessed FP_FP files and HC_HC files (as many as given by the user or as many as occur on each of the nights being used via apero_processing). It combines the FP_FP and HC_HC files into a single`FP_FP` and a single HC_HC file (via a median combination of the images). These combined FP_FP and HC_HC files are then extracted.

The rest of the process is similar to the reference wavelength solution. The wavelength solution is determined as follows:

Under the assumption that the reference wavelength solution is correct at the pixel level, identify HC lines (catalog wavelength) and FP peaks (FP order).

By combining the reference chromatic FP cavity length and position of FP peaks of known FP order, fit a per-order wavelength solution.

Using that wavelength solution, measure the velocity offset in the position of HC lines (\(\Delta v_{\rm HC}\)) and derive an achromatic increment to be applied to the FP cavity

Scale the 0th order term of the Nth order cavity polynomial by \(1-\frac{\Delta v_{\rm HC}}{c}\), where c is the speed of light in the units of \(\Delta v_{\rm HC}\).

Iterate the last two steps until \(\Delta v_{\rm HC}\) is consistent with zero.

The main difference with the reference wavelength solution for fiber AB is that while we start the calculation of the wavelength solution with the cavity fit and wavelength solution from the reference wavelength solution calibration, we only allow for changes in the achromatic term. This is because the chromatic dependence of the cavity width is related to the coating of the FP etalon, and is therefore not expected to change rapidly. An achromatic shift, on the other hand, corresponds to a change in the cavity length of the FP, due in part to pressure or temperature variations, which may happen between nights. Meanwhile, for fibers A, B, and C we fit nothing and use the fiber AB wavelength cavity coefficients. The FP mask for quality control is also not re-generated. Therefore all cross-correlations between fibers AB and A, B, and C are done relative to the reference night wavelength solution (however we only check quality control on \(AB-A\), \(AB-B\), \(AB-C\)). As with the reference wavelength solution recipe, a wavelength solution for each fiber, and the FP and HC lines founds during the process, are then saved to the calibration database for use throughout APERO.

2. Schematic¶

No schematic set

3. Usage¶

apero_wave_night_spirou.py {obs_dir}[STRING] --hcfiles[FILE:HCONE_HCONE] --fpfiles[FILE:FP_FP] {options}

{obs_dir}[STRING] // [STRING] The directory to find the data files in. Most of the time this is organised by nightly observation directory
--hcfiles[FILE:HCONE_HCONE] // Current allowed types: HC1_HC1
--fpfiles[FILE:FP_FP] // Current allowed types: FP_FP

4. Optional Arguments¶

--database[True/False] // [BOOLEAN] Whether to add outputs to calibration database
--badpixfile[FILE:BADPIX] // [STRING] Define a custom file to use for bad pixel correction. Checks for an absolute path and then checks 'directory'
--badcorr[True/False] // [BOOLEAN] Whether to correct for the bad pixel file
--backsub[True/False] // [BOOLEAN] Whether to do background subtraction
--blazefile[FILE:FF_BLAZE] // [STRING] Define a custom file to use for blaze correction. If unset uses closest file from calibDB. Checks for an absolute path and then checks 'directory' (CALIBDB=BADPIX)
--combine[True/False] // [BOOLEAN] Whether to combine fits files in file list or to process them separately
--darkfile[FILE:DARKREF] // [STRING] The Dark file to use (CALIBDB=DARKM)
--darkcorr[True/False] // [BOOLEAN] Whether to correct for the dark file
--flipimage[None,x,y,both] // [BOOLEAN] Whether to flip fits image
--fluxunits[ADU/s,e-] // [STRING] Output units for flux
--locofile[FILE:LOC_LOCO] // [STRING] Sets the LOCO file used to get the coefficients (CALIBDB=LOC_{fiber})
--orderpfile[FILE:LOC_ORDERP] // [STRING] Sets the Order Profile file used to get the coefficients (CALIBDB=ORDER_PROFILE_{fiber}
--plot[0>INT>4] // [INTEGER] Plot level. 0 = off, 1 = interactively, 2 = save to file
--resize[True/False] // [BOOLEAN] Whether to resize image
--shapex[FILE:SHAPE_X] // [STRING] Sets the SHAPE DXMAP file used to get the dx correction map (CALIBDB=SHAPEX)
--shapey[FILE:SHAPE_Y] // [STRING] Sets the SHAPE DYMAP file used to get the dy correction map (CALIBDB=SHAPEY)
--shapel[FILE:SHAPEL] // [STRING] Sets the SHAPE local file used to get the local transforms (CALIBDB = SHAPEL)
--wavefile[FILE:WAVESOL_REF,WAVE_NIGHT,WAVESOL_DEFAULT] // [STRING] Define a custom file to use for the wave solution. If unset uses closest file from header or calibDB (depending on setup). Checks for an absolute path and then checks 'directory'
--forceext[True/False] // WAVE_EXTRACT_HELP
--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_FF	Extracted + flat-fielded 2D spectrum	EXT_E2DS_FF	.fits	_e2dsff	AB, A, B, C	–	–	DRS_PP
WAVE_NIGHT	Nightly wavelength solution calibration file	WAVE_NIGHT	.fits	_wave_night	AB, A, B, C	calibration	WAVE	EXT_E2DS, EXT_E2DS_FF
WAVE_HCLIST	Nightly wavelength Hollow cathodeline-list table	WAVE_HCLIST	.fits	_wave_hclines	AB, A, B, C	–	–	EXT_E2DS, EXT_E2DS_FF
WAVE_FPLIST	Nightly wavelength FP line-list calibration file	WAVE_FPLIST	.fits	_wave_fplines	AB, A, B, C	–	–	EXT_E2DS, EXT_E2DS_FF
CCF_RV	Cross-correlation RV results file	CCF_RV	.fits	_ccf	AB, A, B, C	–	–	EXT_E2DS_FF, TELLU_OBJ

8. Debug plots¶

WAVE_WL_CAV
WAVE_FIBER_COMPARISON
WAVE_FIBER_COMP
WAVE_HC_DIFF_HIST
WAVEREF_EXPECTED
EXTRACT_S1D
EXTRACT_S1D_WEIGHT
WAVE_RESMAP
CCF_RV_FIT
CCF_RV_FIT_LOOP

9. Summary plots¶

SUM_WAVE_FIBER_COMP
SUM_CCF_RV_FIT