apero_loc_nirps_he

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: LOC

No description set

2. Schematic

No schematic set

3. Usage

apero_loc_nirps_he.py {obs_dir}[STRING] [FILE:DARK_FLAT,FLAT_DARK,CALIB_FLAT_DARK,CALIB_DARK_FLAT] {options}

{obs_dir}[STRING] // [STRING] The directory to find the data files in. Most of the time this is organised by nightly observation directory
[FILE:DARK_FLAT,FLAT_DARK,CALIB_FLAT_DARK,CALIB_DARK_FLAT] // [STRING/STRINGS] A list of fits files to use separated by spaces. Current allowed types: DARK_FLAT OR FLAT_DARK but not both (exclusive)

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
--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
--plot[0>INT>4] // [INTEGER] Plot level. 0 = off, 1 = interactively, 2 = save to file
--resize[True/False] // [BOOLEAN] Whether to resize image
--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
LOC_ORDERP	Localisation: Order profile calibration file	LOC_ORDERP	.fits	_order_profile	A, B	calibration	ORDER_PROFILE	FLAT_DARK, DARK_FLAT
LOC_LOCO	Localisation: Position polynomial calibration file	LOC_LOCO	.fits	_loco	A, B	calibration	LOC	FLAT_DARK, DARK_FLAT
LOC_FWHM	Localisation: Width polynomial calibration file	LOC_FWHM	.fits	_fwhm-order	A, B	–	–	FLAT_DARK, DARK_FLAT
LOC_SUP	Localisation: Position superpositionimage calibration file	LOC_SUP	.fits	_with-order	A, B	–	–	FLAT_DARK, DARK_FLAT
DEBUG_BACK	Individual file background map	DEBUG_BACK	.fits	_background.fits	–	–	–	DRS_PP

8. Debug plots

LOC_WIDTH_REGIONS
LOC_FIBER_DOUBLET_PARITY
LOC_GAP_ORDERS
LOC_IMAGE_FIT
LOC_IM_CORNER
LOC_IM_REGIONS

9. Summary plots

SUM_LOC_IM_FIT
SUM_LOC_IM_CORNER