Macros
#define	RECIPE_ID "xsh_geom_ifu"

#define	RECIPE_AUTHOR "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"

#define	RECIPE_CONTACT "regis.haigron@obspm.fr"

#define	XSH_GEOM_SLIT_BIN_SIZE_PIPE_UVB 0.16

#define	XSH_GEOM_SLIT_BIN_SIZE_PIPE_VIS 0.16

#define	XSH_GEOM_SLIT_BIN_SIZE_PIPE_NIR 0.2

#define	XSH_GEOM_WAVE_BIN_SIZE_PIPE_UVB 0.04

#define	XSH_GEOM_WAVE_BIN_SIZE_PIPE_VIS 0.04

#define	XSH_GEOM_WAVE_BIN_SIZE_PIPE_NIR 0.1

Functions
static cpl_error_code	xsh_rectify_params_set_defaults_drl (cpl_parameterlist pars, const char rec_id, xsh_instrument inst, xsh_rectify_param rectify_par)

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

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

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

static void	xsh_geom_ifu (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 cpl_error_code	xsh_params_bin_scale (cpl_frameset raws, xsh_background_param backg)
	Scales input parameters for binning.

static cpl_error_code	xsh_params_monitor (xsh_background_param backg, xsh_rectify_param rectify_par)

static cpl_error_code	xsh_params_set_defaults (cpl_parameterlist pars, xsh_instrument inst, xsh_rectify_param rectify_par, double lambda_ref)

Variables
static char	xsh_geom_ifu_description_short []

static char	xsh_geom_ifu_description []

Detailed Description

This recipe ... See man-page for details.

Macro Definition Documentation

◆ RECIPE_AUTHOR

#define RECIPE_AUTHOR "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"

Definition at line 76 of file xsh_geom_ifu.c.

◆ RECIPE_CONTACT

#define RECIPE_CONTACT "regis.haigron@obspm.fr"

Definition at line 77 of file xsh_geom_ifu.c.

◆ RECIPE_ID

#define RECIPE_ID "xsh_geom_ifu"

Definition at line 75 of file xsh_geom_ifu.c.

◆ XSH_GEOM_SLIT_BIN_SIZE_PIPE_NIR

#define XSH_GEOM_SLIT_BIN_SIZE_PIPE_NIR 0.2

Definition at line 81 of file xsh_geom_ifu.c.

◆ XSH_GEOM_SLIT_BIN_SIZE_PIPE_UVB

#define XSH_GEOM_SLIT_BIN_SIZE_PIPE_UVB 0.16

Definition at line 79 of file xsh_geom_ifu.c.

◆ XSH_GEOM_SLIT_BIN_SIZE_PIPE_VIS

#define XSH_GEOM_SLIT_BIN_SIZE_PIPE_VIS 0.16

Definition at line 80 of file xsh_geom_ifu.c.

◆ XSH_GEOM_WAVE_BIN_SIZE_PIPE_NIR

#define XSH_GEOM_WAVE_BIN_SIZE_PIPE_NIR 0.1

Definition at line 84 of file xsh_geom_ifu.c.

◆ XSH_GEOM_WAVE_BIN_SIZE_PIPE_UVB

#define XSH_GEOM_WAVE_BIN_SIZE_PIPE_UVB 0.04

Definition at line 82 of file xsh_geom_ifu.c.

◆ XSH_GEOM_WAVE_BIN_SIZE_PIPE_VIS

#define XSH_GEOM_WAVE_BIN_SIZE_PIPE_VIS 0.04

Definition at line 83 of file xsh_geom_ifu.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 140 of file xsh_geom_ifu.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_geom_ifu_create(), xsh_geom_ifu_description, xsh_geom_ifu_description_short, xsh_geom_ifu_destroy(), xsh_geom_ifu_exec(), and xsh_get_license().

◆ xsh_geom_ifu()

static void xsh_geom_ifu	(	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.

< Output of remove_crh

< Output of subtract bias

< Output of subtract dark

< Output of subtract background

< Output of xsh_divide_flat

< Output of xsh_rectify_ifu

< Output of remove_crh_single

Definition at line 537 of file xsh_geom_ifu.c.

References assure, check, check_msg, xsh_rectify_param::conserve_flux, instrument, method, xsh_instrument::mode, RECIPE_ID, xsh_localize_ifu_param::use_skymask, xsh_add_product_pre_3d(), xsh_add_product_table(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_blaze_image(), xsh_check_afc(), xsh_check_remove_crh_multiple(), xsh_check_subtract_bias(), xsh_check_subtract_dark(), xsh_compute_shift_ifu(), xsh_create_map(), xsh_create_model_map(), xsh_cube(), xsh_cube_qc_trace_window(), xsh_dfs_split_nir(), XSH_DISP_TAB_AFC, xsh_divide_by_blaze(), xsh_divide_flat(), xsh_end(), xsh_error_reset, xsh_find_frame_with_tag(), xsh_find_master_bias(), xsh_find_master_bpmap(), xsh_find_master_dark(), xsh_find_master_flat(), xsh_find_order_tab_edges(), xsh_find_slitmap(), xsh_find_spectral_format(), xsh_find_wave_tab_ifu(), xsh_find_wavemap(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), xsh_geom_ifu_description_short, XSH_GET_TAG_FROM_ARM, xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_localize_ifu(), XSH_MASTER_DARK, xsh_merge_ord_ifu(), XSH_MOD_CFG_OPT_AFC, XSH_MOD_CFG_TAB, XSH_MODE_IFU, xsh_model_temperature_update_frame(), xsh_msg, xsh_msg_error, xsh_msg_warning, XSH_OBJECT_IFU_STARE, xsh_parameters_background_get(), xsh_parameters_clipping_crh_get(), xsh_parameters_get_boolean(), xsh_parameters_get_double(), xsh_parameters_get_int(), xsh_parameters_get_string(), xsh_parameters_localize_ifu_get(), xsh_parameters_rectify_get(), xsh_parameters_remove_crh_single_get(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_params_set_defaults(), xsh_pfits_get_naxis2(), xsh_prepare(), xsh_recipe_params_check(), xsh_rectify_ifu(), xsh_set_recipe_file_prefix(), XSH_SKY_LINE_LIST, XSH_SLIT_MAP_MODEL, XSH_SLIT_STARE_REMOVE_CRH, xsh_stack_frames_get(), xsh_subtract_background(), XSH_TRACE, XSH_WAVE_MAP_MODEL, and XSH_WAVE_TAB_2D.

Referenced by xsh_geom_ifu_exec().

◆ xsh_geom_ifu_create()

static int xsh_geom_ifu_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 182 of file xsh_geom_ifu.c.

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_background_create(), xsh_parameters_clipping_crh_create(), xsh_parameters_decode_bp(), xsh_parameters_generic(), xsh_parameters_localize_ifu_create(), xsh_parameters_new_boolean(), xsh_parameters_new_double(), xsh_parameters_new_int(), xsh_parameters_pre_overscan(), xsh_parameters_rectify_create(), xsh_parameters_remove_crh_single_create(), and xsh_parameters_stack_create().

Referenced by cpl_plugin_get_info().

◆ xsh_geom_ifu_destroy()

static int xsh_geom_ifu_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 407 of file xsh_geom_ifu.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

◆ xsh_geom_ifu_exec()

static int xsh_geom_ifu_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 373 of file xsh_geom_ifu.c.

References assure, xsh_error_dump, xsh_error_reset, and xsh_geom_ifu().

Referenced by cpl_plugin_get_info().

◆ xsh_params_bin_scale()

static cpl_error_code xsh_params_bin_scale	(	cpl_frameset *	raws,
		xsh_background_param *	backg
	)

static

Scales input parameters for binning.

Parameters

raws	the frames list
backg	the structure controlling inter-order background computation

In case of failure the cpl_error_code is set.

Definition at line 299 of file xsh_geom_ifu.c.

References binx, biny, check, xsh_background_param::radius_x, xsh_background_param::radius_y, xsh_free_propertylist(), xsh_pfits_get_binx(), and xsh_pfits_get_biny().

Referenced by xsh_geom_ifu().

◆ xsh_params_monitor()

static cpl_error_code xsh_params_monitor	(	xsh_background_param *	backg,
		xsh_rectify_param *	rectify_par
	)

static

Definition at line 436 of file xsh_geom_ifu.c.

References xsh_background_param::radius_x, xsh_background_param::radius_y, xsh_rectify_param::rectif_bin_lambda, xsh_rectify_param::rectif_bin_space, xsh_rectify_param::rectif_radius, xsh_background_param::sampley, and xsh_msg_dbg_low.

Referenced by xsh_geom_ifu().

◆ xsh_params_set_defaults()

static cpl_error_code xsh_params_set_defaults	(	cpl_parameterlist *	pars,
		xsh_instrument *	inst,
		xsh_rectify_param *	rectify_par,
		double *	lambda_ref
	)

static

Definition at line 456 of file xsh_geom_ifu.c.

References check, RECIPE_ID, XSH_ARM_NIR, XSH_ARM_UVB, XSH_CORRECTIFU_LAMBDAREF_PIPE_NIR, XSH_CORRECTIFU_LAMBDAREF_PIPE_UVB, XSH_CORRECTIFU_LAMBDAREF_PIPE_VIS, xsh_instrument_get_arm(), xsh_parameters_find(), and xsh_rectify_params_set_defaults_drl().

Referenced by xsh_geom_ifu().

◆ xsh_rectify_params_set_defaults_drl()

static cpl_error_code xsh_rectify_params_set_defaults_drl	(	cpl_parameterlist *	pars,
		const char *	rec_id,
		xsh_instrument *	inst,
		xsh_rectify_param *	rectify_par
	)

static

Definition at line 488 of file xsh_geom_ifu.c.

References check, xsh_rectify_param::rectif_bin_lambda, xsh_rectify_param::rectif_bin_space, XSH_ARM_NIR, XSH_ARM_UVB, XSH_ARM_VIS, XSH_GEOM_SLIT_BIN_SIZE_PIPE_NIR, XSH_GEOM_SLIT_BIN_SIZE_PIPE_UVB, XSH_GEOM_SLIT_BIN_SIZE_PIPE_VIS, XSH_GEOM_WAVE_BIN_SIZE_PIPE_NIR, XSH_GEOM_WAVE_BIN_SIZE_PIPE_UVB, XSH_GEOM_WAVE_BIN_SIZE_PIPE_VIS, xsh_instrument_get_arm(), and xsh_parameters_find().

Referenced by xsh_params_set_defaults().

Variable Documentation

◆ xsh_geom_ifu_description

char xsh_geom_ifu_description[]

static

Initial value:

=
"This recipe Produces the spatial geometry of the IFU pattern on the sky\n\
Input Frames : \n\
  - A set of n science frames ( n == 1 or >=3, Tag = TRACE_arm)\n\
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)\n\
  - [OPTIONAL] A master dark frame (Tag = MASTER_DARK_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)\n\
  - An AFC corrected model order edges table for IFU frame (Tag = ORDER_TAB_AFC_IFU_arm)\n\
  - [PHYSMOD] An AFC corrected model cfg frame (Tag = XSH_MOD_CFG_OPT_AFC_arm)\n\
  - [POLY] An AFC corrected model wavesol frame (Tag = WAVE_TAB_AFC_arm)\n\
  -  An AFC corrected dispersion solution frame (Tag = DISP_TAB_AFC_arm)\n\
  - [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm)\n\
Products : \n\
  - A set of shift offset tables (Tag = OFFSET_TAB_slitlet_IFU_arm)\n"

Definition at line 111 of file xsh_geom_ifu.c.

Referenced by cpl_plugin_get_info().

◆ xsh_geom_ifu_description_short

char xsh_geom_ifu_description_short[]

static

Initial value:

=

"Produces the spatial geometry of the IFU pattern on the sky"

Definition at line 108 of file xsh_geom_ifu.c.

Referenced by cpl_plugin_get_info(), and xsh_geom_ifu().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ RECIPE_AUTHOR

◆ RECIPE_CONTACT

◆ RECIPE_ID

◆ XSH_GEOM_SLIT_BIN_SIZE_PIPE_NIR

◆ XSH_GEOM_SLIT_BIN_SIZE_PIPE_UVB

◆ XSH_GEOM_SLIT_BIN_SIZE_PIPE_VIS

◆ XSH_GEOM_WAVE_BIN_SIZE_PIPE_NIR

◆ XSH_GEOM_WAVE_BIN_SIZE_PIPE_UVB

◆ XSH_GEOM_WAVE_BIN_SIZE_PIPE_VIS

Function Documentation

◆ cpl_plugin_get_info()

◆ xsh_geom_ifu()

◆ xsh_geom_ifu_create()

◆ xsh_geom_ifu_destroy()

◆ xsh_geom_ifu_exec()

◆ xsh_params_bin_scale()

◆ xsh_params_monitor()

◆ xsh_params_set_defaults()

◆ xsh_rectify_params_set_defaults_drl()

Variable Documentation

◆ xsh_geom_ifu_description

◆ xsh_geom_ifu_description_short