xsh_scired_ifu_offset
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_scired_ifu_offset"
#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_set_defaults (cpl_parameterlist *pars, xsh_instrument *inst, xsh_rectify_param *rectify_par)
 set parameters defaults
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_background_param *backg, 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.


Define Documentation

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

Definition at line 71 of file xsh_util_ifu_offset.c.

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

Definition at line 67 of file xsh_scired_ifu_offset.c.

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

Definition at line 72 of file xsh_util_ifu_offset.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 68 of file xsh_scired_ifu_offset.c.

#define RECIPE_ID   "xsh_scired_ifu_offset"

Definition at line 70 of file xsh_util_ifu_offset.c.

#define RECIPE_ID   "xsh_scired_ifu_offset"

Definition at line 66 of file xsh_scired_ifu_offset.c.


Function Documentation

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_util_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().

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

scale relevant input parameters for binning

Scale 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.

Parameters:
raws the frames list
backg inter-order background correction

In case of failure the cpl_error_code is set.

Definition at line 396 of file xsh_util_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().

static cpl_error_code xsh_params_monitor ( xsh_background_param backg,
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 367 of file xsh_util_ifu_offset.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, xsh_background_param::smooth_x, xsh_background_param::smooth_y, and xsh_msg_dbg_low.

Referenced by xsh_scired_ifu_offset().

static cpl_error_code xsh_params_monitor ( xsh_background_param backg,
xsh_rectify_param rectify_par,
xsh_localize_obj_param loc_obj_par 
) [static]
static cpl_error_code xsh_params_set_defaults ( cpl_parameterlist *  pars,
xsh_instrument inst,
xsh_rectify_param rectify_par 
) [static]

set parameters defaults

Parameters:
pars input parameters
inst instrument setting
rectify_par rectify parameters
Returns:
cpl_error_code

Definition at line 309 of file xsh_util_ifu_offset.c.

References check, RECIPE_ID, xsh_rectify_param::rectif_bin_lambda, xsh_rectify_param::rectif_bin_space, XSH_ARM_NIR, xsh_instrument_get_arm(), xsh_parameter_get_default_flag(), xsh_parameters_find(), XSH_SLIT_BIN_SIZE_PIPE_NIR, XSH_SLIT_BIN_SIZE_PIPE_UVB, XSH_WAVE_BIN_SIZE_PIPE_NIR, and XSH_WAVE_BIN_SIZE_PIPE_UVB.

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

< Output of xsh_localize_object

< Final (result) frame

< frameset of rectified frames

< frameset of rectified frames

< 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 515 of file xsh_util_ifu_offset.c.

References assure, check, instrument, xsh_instrument::mode, RECIPE_ID, xsh_rectify_param::rectify_full_slit, XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_build_ifu_cube(), xsh_combine_offset(), xsh_create_map(), xsh_create_model_map(), xsh_dfs_split_offset(), xsh_divide_flat(), xsh_end(), xsh_ensure_raws_input_offset_recipe_is_proper(), xsh_error_reset, xsh_find_frame_with_tag(), xsh_find_master_bpmap(), xsh_find_master_flat(), xsh_find_order_tab_edges(), xsh_find_slitmap(), xsh_find_spectral_format(), xsh_find_wavemap(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), XSH_MASTER_BIAS, XSH_MASTER_DARK, XSH_MOD_CFG_OPT_AFC, XSH_MODE_IFU, xsh_mode_set(), XSH_MODE_SLIT, xsh_model_temperature_update_frame(), xsh_msg, xsh_msg_warning, XSH_OBJECT_IFU_OFFSET, xsh_parameters_background_get(), xsh_parameters_clipping_crh_get(), xsh_parameters_get_boolean(), xsh_parameters_rectify_get(), xsh_parameters_remove_crh_single_get(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_params_set_defaults(), xsh_prepare(), xsh_remove_crh_single(), xsh_scired_ifu_offset_description_short, xsh_set_recipe_file_prefix(), XSH_SKY_IFU, XSH_SLICE_OFFSET, XSH_SLIT_MAP_MODEL, XSH_STD_FLUX_IFU_OFFSET, XSH_STD_TELL_IFU_OFFSET, xsh_stringcat_any(), xsh_subtract_background(), xsh_subtract_sky_offset(), xsh_util_frameset_collapse_mean(), XSH_WAVE_MAP_MODEL, and XSH_WAVE_TAB_AFC.

Referenced by xsh_scired_ifu_offset_exec().

static int xsh_scired_ifu_offset_create ( cpl_plugin *  plugin  )  [static]
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 477 of file xsh_util_ifu_offset.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

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 275 of file xsh_util_ifu_offset.c.

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

Referenced by cpl_plugin_get_info().


Variable Documentation

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 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_util_ifu_offset.c.

Referenced by cpl_plugin_get_info().

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 91 of file xsh_scired_ifu_offset.c.

Initial value:
"Reduce science IFU on-off exposures and build a 3D cube"

Definition at line 92 of file xsh_util_ifu_offset.c.

Referenced by cpl_plugin_get_info(), and xsh_scired_ifu_offset().

Initial value:
"Reduce science exposure in IFU configuration and on/off mode"

Definition at line 88 of file xsh_scired_ifu_offset.c.


Generated on 9 Mar 2011 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1