xsh_respon_slit_stare
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_respon_slit_stare"
#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani"
#define RECIPE_CONTACT   "amodigli@eso.org "

Functions

static int xsh_respon_slit_stare_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_respon_slit_stare_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_respon_slit_stare_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static cpl_error_code xsh_respon_slit_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_monitor (xsh_background_param *backg, xsh_rectify_param *rectify_par, xsh_localize_obj_param *loc_obj_par, xsh_opt_extract_param *opt_extract_par, int sub_sky_nbkpts1, int sub_sky_nbkpts2)

Variables

static char xsh_respon_slit_stare_description_short []
static char xsh_respon_slit_stare_description []

Detailed Description

This recipe computes the response function for UVB / VIS See man-page for details.


Define Documentation

#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani"

Definition at line 76 of file xsh_respon_slit_stare.c.

#define RECIPE_CONTACT   "amodigli@eso.org "

Definition at line 77 of file xsh_respon_slit_stare.c.

#define RECIPE_ID   "xsh_respon_slit_stare"

Definition at line 75 of file xsh_respon_slit_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 145 of file xsh_respon_slit_stare.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_respon_slit_stare_create(), xsh_respon_slit_stare_description, xsh_respon_slit_stare_description_short, xsh_respon_slit_stare_destroy(), and xsh_respon_slit_stare_exec().

static cpl_error_code xsh_params_monitor ( xsh_background_param backg,
xsh_rectify_param rectify_par,
xsh_localize_obj_param loc_obj_par,
xsh_opt_extract_param opt_extract_par,
int  sub_sky_nbkpts1,
int  sub_sky_nbkpts2 
) [static]
static cpl_error_code xsh_respon_slit_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.

< Nb of breakpoints for the first call to subtract_sky_single

< Nb of breakpoints for the second call to subtract_sky_single

< Output of prepare

< Output of subtract bias

< Output of subtract dark

< Output of subtract background

< Output of xsh_divide_flat

< Output of xsh_subtract_sky_single

< Output of xsh_subtract_sky_single Second pass (with localization table)

< Output of xsh_rectify

< Output of xsh_localize_object

< Output of remove_crh_single

< Output of xsh_rectify

< Output of xsh_rectify

< Output of xsh_rectify

< output of xsh_mark_tell

< Output of merge_ord

< Sky spectrum (REC)

< Sky spectrum (REC)

< computed response frame

< computed response frame

< computed response frame

Definition at line 410 of file xsh_respon_slit_stare.c.

References xsh_instrument::arm, assure, check, check_msg, xsh_rectify_param::conserve_flux, xsh_pre::exptime, exptime, instrument, LOCALIZATION_METHOD, xsh_instrument::mode, RECIPE_ID, SUBTRACT_SKY_SINGLE_NBKPTS, xsh_add_afc_info(), xsh_add_product_image(), xsh_add_product_spectrum(), xsh_add_product_table(), xsh_add_temporary_file(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL_MSG, XSH_ASSURE_NOT_NULL, XSH_ATMOS_EXT, xsh_begin(), xsh_calib_nir_corr_if_JH(), xsh_calib_nir_respon_corr_if_JH(), xsh_check_divide_flat(), xsh_check_subtract_bias(), xsh_check_subtract_dark(), xsh_check_subtract_sky_single(), xsh_compute_efficiency(), xsh_compute_resampling_accuracy(), xsh_compute_response2(), xsh_compute_response_ord(), xsh_compute_wavelength_resampling_accuracy(), xsh_end(), xsh_extract_clean(), xsh_find_disp_tab(), xsh_find_frame_with_tag(), xsh_find_std_flux(), xsh_flux_calibrate(), xsh_flux_calibrate1D(), XSH_FLUX_STD_CAT, xsh_frame_table_monitor_flux_qc(), xsh_frameset_uniform_bin(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), XSH_HIGH_ABS_WIN, xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_nir_corr_if_JH(), xsh_merge_ord(), XSH_MODE_SLIT, xsh_monitor_spectrum1D_flux(), XSH_MRESPONSE_MERGE1D_SLIT, xsh_msg, xsh_msg_dbg_low, xsh_msg_dbg_medium, xsh_msg_error, xsh_msg_warning, xsh_multiply_flat(), xsh_opt_extract(), XSH_ORDER2D, xsh_parameters_get_boolean(), xsh_parameters_get_int(), xsh_parameters_interpolate_bp_get(), xsh_parameters_subtract_sky_single_get_true(), xsh_params_monitor(), xsh_pre_free(), xsh_pre_load(), xsh_prepare(), xsh_print_rec_status(), xsh_recipe_params_check(), xsh_rectify(), xsh_rectify_params_set_defaults(), xsh_remove_crh_single(), xsh_respon_slit_stare_description_short, xsh_set_recipe_file_prefix(), xsh_set_recipe_sky_file_prefix(), xsh_slit_stare_correct_crh_and_sky(), xsh_slit_stare_get_calibs(), xsh_slit_stare_get_maps(), xsh_slit_stare_get_params(), xsh_stare_params_bin_scale(), XSH_STD_FLUX_SLIT_STARE, XSH_STD_TELL_SLIT_STARE, xsh_subtract_background(), and XSH_TELL_MOD_CAT.

Referenced by xsh_respon_slit_stare_exec().

static int xsh_respon_slit_stare_create ( cpl_plugin *  plugin  )  [static]
static int xsh_respon_slit_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 342 of file xsh_respon_slit_stare.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_respon_slit_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 308 of file xsh_respon_slit_stare.c.

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

Referenced by cpl_plugin_get_info().


Variable Documentation

Initial value:
"This recipe computes the response function for arm\n\
Input Frames : \n\
  - A RAW frame (Tag = STD_FLUX_SLIT_STARE_arm, Type = RAW)\n\
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm, Type = PRE)\n\
  - A master dark frame (Tag = MASTER_DARK_arm Type = PRE)\n\
  - A master flat frame (Tag = MASTER_FLAT_SLIT_arm Type = PRE)\n\
  - An order table frame(Tag = ORDER_TAB_EDGES_arm Type = ORD)\n\
  - A wave solution frame(Tag = WAVE_TAB_2D_arm, Type = WAV)\n\
  - [OPTIONAL] Table with dispersion coefficients (Tag = DISP_TAB_arm)\n\
  - [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm, Type = QUP)\n\
  - [OPTIONAL] A telluric mask (Tag = TELL_MASK_arm Type = LIN)\n\
  - A standard star fluxes catalog (Tag = STD_STAR_CATALOG_arm Type = FLX)\n\
  - An atmospheric extinction table (Tag = ATMOS_EXT_arm)\n\
  - [OPTIONAL] An master response curve table (Tag = MRESPONSE_MERGE1D_SLIT_arm)\n\
    if provided this is the one used to flux calibrate the spectra\n\
Products : \n\
  - [If STD is in catal] The response ord-by-ord function (Tag = PREFIX_RESPONSE_ORDER1D_SLIT_arm)\n\
  - [If STD is in catal] The response merged function (Tag = PREFIX_RESPONSE_MERGE1D_SLIT_arm)\n\
  - The extracted 2D specturm (Tag = PREFIX_ORDER2D_arm)\n\
  - The extracted 1D specturm (Tag = PREFIX_ORDER1D_arm)\n\
  - The merged 2D specturm (Tag = PREFIX_MERGE2D_arm)\n\
  - The merged 1D specturm (Tag = PREFIX_MERGE1D_arm)\n\
  - The merged 2D sky frame (Tag = SLY_SLIT_MERGED2D)\n\
 - [If STD is in catal] Flux calibrated merged 2D spectrum (Tag = PREFIX_FLUX_ORDER2D_arm)\n\
 - [If STD is in catal] Flux calibrated merged 1D spectrum (Tag = PREFIX_FLUX_ORDER1D_arm)\n\
 - [If STD is in catal] Flux calibrated merged 2D spectrum (Tag = PREFIX_FLUX_MERGE2D_arm)\n\
 - [If STD is in catal] Flux calibrated merged 1D spectrum (Tag = PREFIX_FLUX_MERGE1D_arm)\n\
 - [If STD is in catal] The efficiency (Tag = EFFICIENCY_SLIT_arm)\n\
 - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC"

Definition at line 100 of file xsh_respon_slit_stare.c.

Referenced by cpl_plugin_get_info().

Initial value:
"Compute the response function in SLIT stare mode"

Definition at line 97 of file xsh_respon_slit_stare.c.

Referenced by cpl_plugin_get_info(), and xsh_respon_slit_stare().


Generated on 13 Mar 2013 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1