xsh_scired_ifu_offset

Macros
#define	RECIPE_ID   "xsh_scired_ifu_offset_drl"
#define	RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"
#define	RECIPE_CONTACT   "amodigli@eso.org"
#define	RECIPE_ID   "xsh_scired_ifu_offset"
#define	RECIPE_AUTHOR   "A.Modigliani, J.Vernet, P. Bristow"
#define	RECIPE_CONTACT   "Andrea.Modigliani@eso.org"

Functions
static int	xsh_scired_ifu_offset_create (cpl_plugin *plugin)
	Setup the recipe options.
static int	xsh_scired_ifu_offset_exec (cpl_plugin *plugin)
	Execute the plugin instance given by the interface.
static int	xsh_scired_ifu_offset_destroy (cpl_plugin *plugin)
	Destroy what has been created by the 'create' function.
static void	xsh_scired_ifu_offset (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_monitor (xsh_background_param *backg, xsh_rectify_param *rectify_par, xsh_localize_obj_param *loc_obj_par)
static cpl_error_code	xsh_params_bin_scale (cpl_frameset *raws, xsh_background_param *backg)
	scale relevant input parameters for binning
static cpl_error_code	xsh_params_monitor (xsh_rectify_param *rectify_par)
	monitor parameters value

Variables
static char	xsh_scired_ifu_offset_description_short []
static char	xsh_scired_ifu_offset_description []
static char	xsh_scired_ifu_offset_description_short []
static char	xsh_scired_ifu_offset_description []

Detailed Description

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

Macro Definition Documentation

RECIPE_AUTHOR [1/2]

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

Definition at line 71 of file xsh_scired_ifu_offset.c.

RECIPE_AUTHOR [2/2]

#define RECIPE_AUTHOR   "A.Modigliani, J.Vernet, P. Bristow"

Definition at line 74 of file xsh_util_ifu_offset.c.

RECIPE_CONTACT [1/2]

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 72 of file xsh_scired_ifu_offset.c.

RECIPE_CONTACT [2/2]

#define RECIPE_CONTACT   "Andrea.Modigliani@eso.org"

Definition at line 75 of file xsh_util_ifu_offset.c.

RECIPE_ID [1/2]

#define RECIPE_ID   "xsh_scired_ifu_offset_drl"

Definition at line 70 of file xsh_scired_ifu_offset.c.

RECIPE_ID [2/2]

#define RECIPE_ID   "xsh_scired_ifu_offset"

Definition at line 73 of file xsh_util_ifu_offset.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 128 of file xsh_scired_ifu_offset.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_scired_ifu_offset_create(), xsh_scired_ifu_offset_description, xsh_scired_ifu_offset_description_short, xsh_scired_ifu_offset_destroy(), and xsh_scired_ifu_offset_exec().

xsh_params_bin_scale()

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

static

scale relevant input parameters for binning

Parameters

raws	the frames list
backg	structure to control inter-order background computation

In case of failure the cpl_error_code is set.

Definition at line 353 of file xsh_scired_ifu_offset.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_scired_ifu_offset().

xsh_params_monitor() [1/2]

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

static

Definition at line 320 of file xsh_scired_ifu_offset.c.

References xsh_localize_obj_param::loc_chunk_nb, xsh_localize_obj_param::nod_step, 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_scired_ifu_offset().

xsh_params_monitor() [2/2]

static cpl_error_code xsh_params_monitor ( xsh_rectify_param *  rectify_par )

static

monitor parameters value

Parameters

backg	inter-order background parameters
rectify_par	rectification parameters

Returns

cpl_error_code

Definition at line 322 of file xsh_util_ifu_offset.c.

References xsh_rectify_param::rectif_bin_lambda, xsh_rectify_param::rectif_bin_space, xsh_rectify_param::rectif_radius, and xsh_msg_dbg_low.

Referenced by xsh_scired_ifu_offset().

xsh_scired_ifu_offset()

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

< frameset of subtracted offset frames

< frameset of frames after subtract bkg

< frameset of clean frames after divide flat

< Comined frame

< Rectifid frame set

< Final (result) frame

< frameset of rectified frames

< frameset of rectified frames

Definition at line 467 of file xsh_scired_ifu_offset.c.

References assure, check, xsh_rectify_param::conserve_flux, instrument, LOCALIZATION_METHOD, method, xsh_extract_param::method, xsh_instrument::mode, RECIPE_ID, xsh_add_product_image(), xsh_add_product_pre(), xsh_add_product_pre_3d(), xsh_add_product_spectrum(), xsh_add_product_table(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_blaze_image(), xsh_check_afc(), xsh_check_get_map(), xsh_combine_offset(), xsh_cube(), xsh_cube_qc_trace_window(), xsh_dfs_split_offset(), xsh_divide_by_blaze(), xsh_divide_flat(), xsh_end(), xsh_ensure_raws_input_offset_recipe_is_proper(), xsh_error_reset, xsh_extract_ifu(), xsh_find_disp_tab(), xsh_find_frame_with_tag(), xsh_find_master_bpmap(), xsh_find_master_flat(), xsh_find_offset_tab_ifu(), xsh_find_order_tab_edges(), xsh_find_spectral_format(), xsh_find_wave_tab_ifu(), xsh_frameset_ext_image_frames(), xsh_frameset_ext_table_frames(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_localize_obj_ifu(), XSH_MASTER_BIAS, XSH_MASTER_DARK, xsh_merge_ord_ifu(), XSH_MOD_CFG_OPT_AFC, XSH_MOD_CFG_TAB, XSH_MODE_IFU, xsh_monitor_spectrum1D_flux(), xsh_msg, xsh_msg_dbg_low, xsh_msg_warning, XSH_OBJECT_IFU_OFFSET, xsh_parameters_background_get(), xsh_parameters_bary_corr_get(), xsh_parameters_extract_get(), xsh_parameters_get_boolean(), xsh_parameters_get_double(), xsh_parameters_get_string(), xsh_parameters_localize_obj_get(), xsh_parameters_rectify_get(), xsh_parameters_remove_crh_single_get(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_pfits_get_naxis2(), xsh_prepare(), xsh_recipe_params_check(), xsh_rectify_ifu(), xsh_rectify_params_set_defaults(), xsh_remove_crh_single(), xsh_scired_ifu_offset_description_short, xsh_set_recipe_file_prefix(), xsh_shift_offsettab(), XSH_SKY_IFU, xsh_stack_frames_get(), XSH_STD_FLUX_IFU_OFFSET, XSH_STD_TELL_IFU_OFFSET, xsh_subtract_background(), and xsh_subtract_sky_offset().

Referenced by xsh_scired_ifu_offset_exec().

xsh_scired_ifu_offset_create()

static int xsh_scired_ifu_offset_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 170 of file xsh_scired_ifu_offset.c.

References assure, BARY_CORR_NONE, check, LOC_MANUAL_METHOD, LOCALIZATION_METHOD, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_background_create(), xsh_parameters_bary_corr_create(), xsh_parameters_clipping_crh_create(), xsh_parameters_decode_bp(), xsh_parameters_extract_create(), xsh_parameters_generic(), xsh_parameters_interpolate_bp_create(), xsh_parameters_localize_obj_create(), xsh_parameters_new_boolean(), xsh_parameters_new_double(), xsh_parameters_pre_overscan(), xsh_parameters_rectify_create(), xsh_parameters_remove_crh_single_create(), xsh_parameters_stack_create(), XSH_SLIT_BIN_SIZE_PIPE_NIR, and XSH_WAVE_BIN_SIZE_PIPE_NIR.

Referenced by cpl_plugin_get_info().

xsh_scired_ifu_offset_destroy()

static int xsh_scired_ifu_offset_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 430 of file xsh_scired_ifu_offset.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

xsh_scired_ifu_offset_exec()

static int xsh_scired_ifu_offset_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 291 of file xsh_scired_ifu_offset.c.

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

Referenced by cpl_plugin_get_info().

Variable Documentation

xsh_scired_ifu_offset_description [1/2]

char xsh_scired_ifu_offset_description[]

static

Initial value:

=
"This recipe reduces science exposure in IFU configuration and on/off mode\n\
Input Frames : \n\
  - A set of 2xn Science frames, \
      Tag = OBJECT_IFU_OFFSET_arm, SKY_IFU_arm\n\
  - A spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)\n\
  - An order table frame(Tag = ORDER_TABLE_EDGES_IFU_arm)\n\
  - 3 wave solution frames, one per slitlet (Tag = WAVE_TAB_ARC_IFU_slitlet_arm)\n\
      where 'slitlet' is DOWN, CEN or UP\n\
  - [OPTIONAL] A dispersion table (Tag = DISP_TAB_IFU_arm)\n\
  - [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm)\n\
Products : \n\
  - 3 Spectrum order tables 2D (1 per slitlet), PRO.CATG=ORDER2D_slitlet_IFU_arm\n\
  - 3 Spectrum order tables 1D (1 per slitlet), PRO.CATG=ORDER1D_slitlet_IFU_arm\n\
  - 3 Spectrum merge tables 2D (1 per slitlet), PRO.CATG=MERGE2D_slitlet_IFU_arm\n\
  - 3 Spectrum merge tables 1D (1 per slitlet), PRO.CATG=MERGE1D_slitlet_IFU_arm\n\
  - 1 Spectrum merge 3D, PRO.CATG=MERGE3D_IFU_arm\n"

Definition at line 95 of file xsh_scired_ifu_offset.c.

Referenced by cpl_plugin_get_info().

xsh_scired_ifu_offset_description [2/2]

char xsh_scired_ifu_offset_description[]

static

Initial value:

=
"This recipe Reduce science IFU on-off exposures and build a 3D cube\n\
Input Frames : \n\
  - A set of 2xn Science frames, \
      Tag = OBJECT_IFU_OFFSET_arm, SKY_IFU_arm\n\
  - A spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)\n\
  - An order table frame(Tag = ORDER_TABLE_EDGES_IFU_arm)\n\
  - 3 wave solution frames, one per slitlet (Tag = WAVE_TAB_ARC_IFU_slitlet_arm)\n\
      where 'slitlet' is DOWN, CEN or UP\n\
  - [OPTIONAL] A dispersion table (Tag = DISP_TAB_IFU_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\
Products : \n\
 - Merged 3D data cube (PREFIX_MERGE3D_DATA_OBJ_arm)\n\
 - QC Traces of 3D data cube (PREFIX_MERGE3D_TRACE_OBJ_arm)\n\
 - Order by order 3D data cube (PREFIX_ORDER3D_DATA_OBJ_arm)\n\
 - Order by order 3D qual cube (IFU_CFG_COR_arm)\n\
 - Order by order 3D qual cube (PREFIX_MERGE3D_DATA_SKY_arm)\n\
 - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC\n\
 - 1 Spectrum merge 3D, PRO.CATG=MERGE3D_IFU_arm\n"

Definition at line 98 of file xsh_util_ifu_offset.c.

xsh_scired_ifu_offset_description_short [1/2]

char xsh_scired_ifu_offset_description_short[]

static

Initial value:

=
"Reduce science exposure in IFU configuration and on/off mode"

Definition at line 92 of file xsh_scired_ifu_offset.c.

Referenced by cpl_plugin_get_info(), and xsh_scired_ifu_offset().

xsh_scired_ifu_offset_description_short [2/2]

char xsh_scired_ifu_offset_description_short[]

static

Initial value:

=
"Reduce science IFU on-off exposures and build a 3D cube"

Definition at line 95 of file xsh_util_ifu_offset.c.

Referenced by xsh_scired_ifu_offset().