xsh_scired_ifu_stare
[Xshooter Recipes]

Defines

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

Functions

static int xsh_scired_ifu_stare_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_scired_ifu_stare_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_scired_ifu_stare_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_scired_ifu_stare (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)
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)
 Scales input parameters for binning.
static cpl_error_code xsh_params_monitor (xsh_background_param *backg, xsh_rectify_param *rectify_par)

Variables

static char xsh_scired_ifu_stare_description_short []
static char xsh_scired_ifu_stare_description []
static char xsh_scired_ifu_stare_description_short []
static char xsh_scired_ifu_stare_description []

Detailed Description

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


Define Documentation

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

Definition at line 72 of file xsh_util_ifu_stare.c.

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

Definition at line 70 of file xsh_scired_ifu_stare.c.

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

Definition at line 73 of file xsh_util_ifu_stare.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 71 of file xsh_scired_ifu_stare.c.

#define RECIPE_ID   "xsh_scired_ifu_stare"

Definition at line 71 of file xsh_util_ifu_stare.c.

#define RECIPE_ID   "xsh_scired_ifu_stare"

Definition at line 69 of file xsh_scired_ifu_stare.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 130 of file xsh_util_ifu_stare.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_scired_ifu_stare_create(), xsh_scired_ifu_stare_description, xsh_scired_ifu_stare_description_short, xsh_scired_ifu_stare_destroy(), and xsh_scired_ifu_stare_exec().

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

Scales input parameters for binning.

Rescale input parameters for binning.

Parameters:
raws the frames list
backg the structure controlling inter-order bacground computation

In case of failure the cpl_error_code is set.

Parameters:
raws the frameset
backg the inter-order background parameters

In case of failure the cpl_error_code is set.

Definition at line 263 of file xsh_util_ifu_stare.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]
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]
static void xsh_scired_ifu_stare ( 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 remove_crh_single

< Output of xsh_divide_flat

< Output of xsh_rectify_ifu

< Output of xsh_localize_object

< Final (result) frame

< Final (result) frame

< Output of remove_crh

< Output of subtract bias

< Output of subtract dark

< Output of subtract background

< Output of xsh_divide_flat

Definition at line 500 of file xsh_util_ifu_stare.c.

References assure, check, check_msg, instrument, xsh_instrument::mode, RECIPE_ID, XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, xsh_begin(), xsh_build_ifu_cube(), xsh_create_map(), xsh_create_model_map(), xsh_dfs_split_nir(), xsh_divide_flat(), xsh_end(), xsh_error_reset, xsh_find_disp_tab(), 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_wavemap(), xsh_frame_check_model_cfg_is_afc_corrected(), xsh_frame_check_model_cfg_is_proper_for_sci(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), XSH_GET_TAG_FROM_ARM, XSH_IFU_CFG_TAB, xsh_ifu_trace_object_calibrate(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), XSH_MASTER_DARK, XSH_MOD_CFG_OPT_AFC, XSH_MOD_CFG_TAB, XSH_MODE_IFU, xsh_mode_set(), XSH_MODE_SLIT, 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_rectify_get(), xsh_parameters_remove_crh_single_get(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_params_set_defaults(), xsh_prepare(), xsh_remove_crh_multiple(), xsh_scired_ifu_stare_description_short, xsh_set_recipe_file_prefix(), XSH_SLIT_MAP_MODEL, XSH_SLIT_STARE_REMOVE_CRH, XSH_STD_FLUX_IFU_STARE, XSH_STD_TELL_IFU_STARE, xsh_subtract_background(), xsh_subtract_bias(), xsh_subtract_dark(), XSH_WAVE_MAP_MODEL, XSH_WAVE_TAB_2D, and XSH_WAVE_TAB_AFC.

Referenced by xsh_scired_ifu_stare_exec().

static int xsh_scired_ifu_stare_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 172 of file xsh_util_ifu_stare.c.

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_background_create(), xsh_parameters_clipping_crh_create(), xsh_parameters_generic(), xsh_parameters_new_boolean(), xsh_parameters_rectify_create(), xsh_parameters_remove_crh_single_create(), XSH_SLIT_BIN_SIZE_PIPE_NIR, and XSH_WAVE_BIN_SIZE_PIPE_NIR.

Referenced by cpl_plugin_get_info().

static int xsh_scired_ifu_stare_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 388 of file xsh_util_ifu_stare.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_scired_ifu_stare_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 354 of file xsh_util_ifu_stare.c.

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

Referenced by cpl_plugin_get_info().


Variable Documentation

Initial value:
"This recipe reduce science IFU stare exposures with 3D cube generation\n\
Input Frames : \n\
  - A set of n Science frames ( n == 1 or >=3, \
    Tag = OBJECT_IFU_STARE_UVB)\n\
  - A spectral format table frame (Tag = SPECTRAL_FORMAT_TAB_arm)\n\
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)\n\
  - A master dark frame (Tag = MASTER_DARK_arm)\n\
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)\n\
  - An order edges table frame(Tag = ORDER_TAB_EDGES_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\
  - [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm)\n\
Products : \n\
  Merged 3D data cube (MERGE3D_DATA_IFU_arm)\n\
  QC Traces of 3D data cube (MERGE3D_TRACE_IFU_arm)\n\
  Order by order 3D data cube (ORDER3D_DATA_IFU_arm)\n\
  Order by order 3D errs cube (ORDER3D_ERRS_IFU_arm)\n\
  Order by order 3D qual cube (ORDER3D_QUAL_IFU_arm)\n"

Definition at line 96 of file xsh_util_ifu_stare.c.

Referenced by cpl_plugin_get_info().

Initial value:
"This recipe reduces science exposure in IFU configuration and stare mode\n\
Input Frames : \n\
  - A set of n Science frames ( n == 1 or >=3, \
Tag = OBJECT_IFU_STARE_arm or STD_TELL_IFU_STARE_arm or STD_FLUX_IFU_STARE_arm)\n\
  - A spectral format table (Tag = SPECTRAL_FORMAT_TAB_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 order table frame(Tag = ORDER_TAB_EDGES_IFU_arm)\n\
  - [poly mode] 3 wave solution frames, one per slitlet(Tag = WAVE_TAB_ARC_slitlet_arm)\n\
       where 'slitlet' is DOWN, CEN or UP\n\
  - [poly mode] A wave solution frame(Tag = WAVE_TAB_2D_arm)\n\
  - [physical model mode] A model cfg table (Format = TABLE, Tag = XSH_MOD_CFG_TAB_arm)\n\
  - [OPTIONAL] A table with dispersion coefficients (Tag = DISP_TAB_arm)\n\
  - [OPTIONAL] A slit map (Tag = SLIT_MAP_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 94 of file xsh_scired_ifu_stare.c.

Initial value:
"Reduce science IFU stare exposures and build a 3D cube"

Definition at line 93 of file xsh_util_ifu_stare.c.

Referenced by cpl_plugin_get_info(), and xsh_scired_ifu_stare().

Initial value:
"Reduce science exposure in IFU configuration and stare mode"

Definition at line 91 of file xsh_scired_ifu_stare.c.


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