Macros
#define	RECIPE_ID "xsh_wavecal"

#define	RECIPE_AUTHOR "L.Guglielmi"

#define	RECIPE_CONTACT "amodigli@eso.org"

Functions
static int	xsh_wavecal_create (cpl_plugin *plugin)
	Setup the recipe options.

static int	xsh_wavecal_exec (cpl_plugin *plugin)
	Execute the plugin instance given by the interface.

static int	xsh_wavecal_destroy (cpl_plugin *plugin)
	Destroy what has been created by the 'create' function.

static void	xsh_wavecal (cpl_parameterlist parameters, cpl_frameset frameset)
	Interpret the command line options and execute the data processing.

int	cpl_plugin_get_info (cpl_pluginlist *list)
	Build the list of available plugins, for this module.

static void	xsh_wavecal_get_parameters (cpl_parameterlist parameters, xsh_follow_arclines_param par)

static cpl_error_code	xsh_params_monitor (xsh_follow_arclines_param follow_param)

static cpl_error_code	xsh_params_set_defaults (cpl_parameterlist pars, xsh_instrument inst)

static cpl_error_code	xsh_params_bin_scale (cpl_frameset *raws, xsh_follow_arclines_param follow_param)
	Scale input parameters.

Variables
static char	xsh_wavecal_description_short []

static char	xsh_wavecal_description []

Detailed Description

This recipe calibrates the arc lines. See man-page for details.

Macro Definition Documentation

◆ RECIPE_AUTHOR

#define RECIPE_AUTHOR "L.Guglielmi"

Definition at line 75 of file xsh_wavecal.c.

◆ RECIPE_CONTACT

#define RECIPE_CONTACT "amodigli@eso.org"

Definition at line 76 of file xsh_wavecal.c.

◆ RECIPE_ID

#define RECIPE_ID "xsh_wavecal"

Definition at line 74 of file xsh_wavecal.c.

Function Documentation

◆ cpl_plugin_get_info()

int cpl_plugin_get_info ( cpl_pluginlist * list )

Build the list of available plugins, for this module.

Parameters

list	the plugin list

Returns: 0 if everything is ok, -1 otherwise

Create the recipe instance and make it available to the application using the interface. This function is exported.

Definition at line 144 of file xsh_wavecal.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_wavecal_create(), xsh_wavecal_description, xsh_wavecal_description_short, xsh_wavecal_destroy(), and xsh_wavecal_exec().

◆ xsh_params_bin_scale()

static cpl_error_code xsh_params_bin_scale	(	cpl_frameset *	raws,
		xsh_follow_arclines_param	follow_param
	)

static

Scale input parameters.

Parameters

raws	the frames list
follow_param	parameter structure to control line tilt follow

In case of failure the cpl_error_code is set.

Definition at line 383 of file xsh_wavecal.c.

References binx, biny, check, xsh_follow_arclines_param::margin, xsh_follow_arclines_param::range, xsh_free_propertylist(), xsh_pfits_get_binx(), and xsh_pfits_get_biny().

Referenced by xsh_wavecal().

◆ xsh_params_monitor()

static cpl_error_code xsh_params_monitor ( xsh_follow_arclines_param follow_param )

static

Definition at line 336 of file xsh_wavecal.c.

References xsh_follow_arclines_param::margin, xsh_follow_arclines_param::range, and xsh_msg_dbg_low.

Referenced by xsh_wavecal().

◆ xsh_params_set_defaults()

static cpl_error_code xsh_params_set_defaults	(	cpl_parameterlist *	pars,
		xsh_instrument *	inst
	)

static

Definition at line 349 of file xsh_wavecal.c.

References check, RECIPE_ID, xsh_instrument_get_mode(), XSH_MODE_IFU, and xsh_parameters_find().

Referenced by xsh_wavecal().

◆ xsh_wavecal()

static void xsh_wavecal	(	cpl_parameterlist *	parameters,
		cpl_frameset *	frameset
	)

static

Interpret the command line options and execute the data processing.

Parameters

parameters	the parameters list
frameset	the frames list

In case of failure the cpl_error_code is set.

Definition at line 427 of file xsh_wavecal.c.

References check, xsh_clipping_param::frac, instrument, xsh_follow_arclines_param::margin, xsh_clipping_param::niter, xsh_follow_arclines_param::range, RECIPE_ID, xsh_clipping_param::sigma, xsh_follow_arclines_param::specres_clipping, xsh_follow_arclines_param::tilt_clipping, xsh_add_product_image(), xsh_add_product_table(), XSH_ARC_LINE_LIST, XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_ILLEGAL_MSG, XSH_ASSURE_NOT_NULL, xsh_begin(), xsh_check_load_master_bpmap(), xsh_check_subtract_dark(), xsh_create_model_map(), xsh_dfs_split_nir(), xsh_end(), xsh_error_reset, xsh_find_disp_tab(), xsh_find_frame_with_tag(), xsh_find_master_dark(), xsh_find_order_tab_edges(), xsh_find_slitmap(), xsh_find_spectral_format(), xsh_find_wave_tab_2d(), xsh_find_wavemap(), xsh_follow_arclines_ifu(), xsh_follow_arclines_slit(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_get_mode(), xsh_instrument_mode_tostring(), xsh_instrument_update_from_spectralformat(), XSH_MASTER_BIAS, XSH_MASTER_DARK, XSH_MOD_CFG_OPT_2D, XSH_MOD_CFG_TAB, XSH_MODE_SLIT, xsh_model_temperature_update_frame(), xsh_msg, xsh_msg_dbg_low, xsh_msg_warning, xsh_params_bin_scale(), xsh_params_monitor(), xsh_params_set_defaults(), xsh_prepare(), xsh_recipe_params_check(), XSH_SLIT_MAP_MODEL, xsh_subtract_bias(), xsh_subtract_nir_on_off(), XSH_WAVE_MAP_MODEL, XSH_WAVECAL, xsh_wavecal_description_short, and xsh_wavecal_get_parameters().

Referenced by xsh_wavecal_exec().

◆ xsh_wavecal_create()

static int xsh_wavecal_create ( cpl_plugin * plugin )

static

Setup the recipe options.

Parameters

plugin the plugin

Returns: 0 if everything is ok

Create the recipe instance and make it available to the application using the interface.

Definition at line 186 of file xsh_wavecal.c.

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_clipping_specres_create(), xsh_parameters_clipping_tilt_create(), xsh_parameters_decode_bp(), xsh_parameters_generic(), xsh_parameters_pre_overscan(), xsh_parameters_wavecal_margin_create(), xsh_parameters_wavecal_range_create(), and xsh_parameters_wavecal_s_n_create().

Referenced by cpl_plugin_get_info().

◆ xsh_wavecal_destroy()

static int xsh_wavecal_destroy ( cpl_plugin * plugin )

static

Destroy what has been created by the 'create' function.

Parameters

plugin the plugin

Returns: 0 if everything is ok

Definition at line 285 of file xsh_wavecal.c.

References assure, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

◆ xsh_wavecal_exec()

static int xsh_wavecal_exec ( cpl_plugin * plugin )

static

Execute the plugin instance given by the interface.

Parameters

plugin the plugin

Returns: 0 if everything is ok

Definition at line 250 of file xsh_wavecal.c.

References assure, xsh_error_dump, and xsh_wavecal().

Referenced by cpl_plugin_get_info().

◆ xsh_wavecal_get_parameters()

static void xsh_wavecal_get_parameters	(	cpl_parameterlist *	parameters,
		xsh_follow_arclines_param *	par
	)

static

Definition at line 311 of file xsh_wavecal.c.

References check, xsh_follow_arclines_param::margin, xsh_follow_arclines_param::range, RECIPE_ID, xsh_follow_arclines_param::s_n_min, xsh_follow_arclines_param::specres_clipping, xsh_follow_arclines_param::tilt_clipping, xsh_parameters_clipping_specres_get(), xsh_parameters_clipping_tilt_get(), xsh_parameters_wavecal_margin_get(), xsh_parameters_wavecal_range_get(), and xsh_parameters_wavecal_s_n_get().

Referenced by xsh_wavecal().

Variable Documentation

◆ xsh_wavecal_description

char xsh_wavecal_description[]

static

Initial value:

=
"This recipe detects and follow arc lines in a fully illuminated slit\n\
frame.\n\
Input Frames:\n\
  Raw frame (Tag = ARC_SLIT_arm)\n\
  Arc Line List (Tag = ARC_LINE_LIST_arm)\n\
  Master Bias (Tag = MASTER_BIAS_arm)\n\
  [OPTIONAL] Master Dark (Tag = MASTER_DARK_arm)\n\
  Order Table (Tag = ORDER_TABLE_EDGES_arm)\n\
  [poly mode] Wave Solution (Tag = WAVE_TAB_2D_arm)\n\
  [poly mode] Theoretical Map (Tag = THEO_TAB_spec_arm, spec=SING/IFU)\n\
  [physical model mode] Model cfg tab (Tag = XSH_MOD_CFG_TAB_arm)\n\
  - [OPTIONAL] A non-linear badpixel map (Tag = BP_MAP_NL_arm)\n\
  - [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm)\n\
  [OPTIONAL-To compute spectral resolution] Dispersion Table Frame (Tag = DISP_TAB_arm)\n\
Prepare PRE structures.\n\
Subtract the master Dark (UVB, VIS and NIR)\n\
Substract the master Bias (UVB and VIS)\n\
Divide by Flat.\n\
Detect and follow arc lines.\n\
Products:\n\
   Wavelength solution, PRO.CATG = WAVE_TAB_ARC_SLIT_arm [if poly mode]\n\
   Linetilt list, PRO.CATG = TILT_TAB_SLIT_arm\n\
   Residuals table, PRO.CATG = RESID_TAB_GOOD_LINES_arm\n\
   Wave Map, PRO.CATG = WAVE_MAP_arm [if model-wavemap-compute=TRUE]\n\
   In case of IFU mode cdata previous producs repat for each IFU slices\n\
   Arc frame, Bias subtracted in PRE format, PRO.CATG = ARC_BIAS_SUBTRACT_arm\n\
   If arm=UVB/VIS and PRO.CATG=ARC_NIR_ON if arm=NIR\n\
   Arc frame, Bias subtracted, FLAT-FIELDED, PRO.CATG = WAVECAL_FLATFIELDED_arm"

Definition at line 99 of file xsh_wavecal.c.

Referenced by cpl_plugin_get_info().

◆ xsh_wavecal_description_short

char xsh_wavecal_description_short[]

static

Initial value:

=

"Compute arclines tilt and instrument resolution"

Definition at line 96 of file xsh_wavecal.c.

Referenced by cpl_plugin_get_info(), and xsh_wavecal().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ RECIPE_AUTHOR

◆ RECIPE_CONTACT

◆ RECIPE_ID

Function Documentation

◆ cpl_plugin_get_info()

◆ xsh_params_bin_scale()

◆ xsh_params_monitor()

◆ xsh_params_set_defaults()

◆ xsh_wavecal()

◆ xsh_wavecal_create()

◆ xsh_wavecal_destroy()

◆ xsh_wavecal_exec()

◆ xsh_wavecal_get_parameters()

Variable Documentation

◆ xsh_wavecal_description

◆ xsh_wavecal_description_short