xsh_mflat
[Xshooter Recipes]

Defines

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

Functions

static int xsh_mflat_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_mflat_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_mflat_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_mflat (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 void xsh_mflat_recipe_main (cpl_frameset *raw_set, cpl_frameset *on_set, cpl_frameset *off_set, cpl_frame *bpmap_frame, cpl_frame *master_bias_frame, cpl_frame *master_dark_frame, cpl_frame *cen_order_tab_frame, cpl_frame *qc_cen_order_tab_frame, xsh_clipping_param *crhclip_par, xsh_detect_order_param *detectorder_par, xsh_background_param *background_par, const int pre_overscan_corr, cpl_frame **edges_order_tab_frame, cpl_frame **master_flat_frame, cpl_frame **rmbackground, cpl_frame **grid_background, cpl_frame **frame_backg, xsh_instrument *instrument)
static cpl_error_code xsh_params_monitor (xsh_background_param *backg, xsh_detect_order_param *det_order)
static cpl_error_code xsh_params_bin_scale (cpl_frameset *raws, xsh_background_param *backg, xsh_detect_order_param *det_order)
 Rescale parameters for binning.
static cpl_error_code xsh_params_set_defaults (cpl_parameterlist *pars, xsh_instrument *inst, xsh_detect_order_param *det_order, xsh_background_param *backg)

Variables

static char xsh_mflat_description_short []
static char xsh_mflat_description []

Detailed Description

This recipe calculates the master flat frame See man-page for details.


Define Documentation

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

Definition at line 72 of file xsh_mflat.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 73 of file xsh_mflat.c.

#define RECIPE_ID   "xsh_mflat"

Definition at line 71 of file xsh_mflat.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 147 of file xsh_mflat.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_mflat_create(), xsh_mflat_description, xsh_mflat_description_short, xsh_mflat_destroy(), and xsh_mflat_exec().

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

Definition at line 563 of file xsh_mflat.c.

References check, crh_clipping, instrument, xsh_instrument::lamp, xsh_d2_detect_order_param::min_sn, xsh_detect_order_param::min_sn, RECIPE_ID, xsh_add_product_bpmap(), xsh_add_product_image(), xsh_add_product_pre(), xsh_add_product_table_multi(), XSH_ARM_NIR, XSH_ARM_UVB, XSH_ASSURE_NOT_ILLEGAL, xsh_badpixelmap_coadd(), xsh_begin(), xsh_check_load_master_bpmap(), xsh_dfs_split_nir(), xsh_dfs_split_qth_d2(), xsh_end(), xsh_error_reset, xsh_find_frame_with_tag(), xsh_find_master_bias(), xsh_find_master_dark(), xsh_find_order_tab_centr(), XSH_FLAT, xsh_flat_merge_qth_d2(), xsh_frame_product(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), xsh_free_table(), xsh_image_mflat_detect_hotcold(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_mode_tostring(), xsh_instrument_update_from_spectralformat(), xsh_instrument_update_lamp(), XSH_LAMP_D2, XSH_LAMP_QTH, XSH_LAMP_QTH_D2, XSH_LAMP_UNDEFINED, XSH_MASTER_DARK, xsh_mflat_description_short, xsh_mflat_recipe_main(), xsh_msg, xsh_msg_warning, xsh_order_split_qth_d2(), xsh_parameters_background_get(), xsh_parameters_clipping_crh_get(), xsh_parameters_d2_detect_order_get(), xsh_parameters_detect_order_get(), xsh_parameters_get_int(), xsh_params_bin_scale(), xsh_params_monitor(), xsh_params_set_defaults(), xsh_pfits_set_pcatg(), and XSH_SPECTRAL_FORMAT.

Referenced by xsh_mflat_exec().

static int xsh_mflat_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 189 of file xsh_mflat.c.

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_background_create(), xsh_parameters_clipping_crh_create(), xsh_parameters_d2_detect_order_create(), xsh_parameters_detect_order_create(), xsh_parameters_generic(), and xsh_parameters_pre_overscan().

Referenced by cpl_plugin_get_info().

static int xsh_mflat_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 289 of file xsh_mflat.c.

References assure, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_mflat_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 255 of file xsh_mflat.c.

References assure, xsh_error_dump, and xsh_mflat().

Referenced by cpl_plugin_get_info().

static void xsh_mflat_recipe_main ( cpl_frameset *  raw_set,
cpl_frameset *  on_set,
cpl_frameset *  off_set,
cpl_frame *  bpmap_frame,
cpl_frame *  master_bias_frame,
cpl_frame *  master_dark_frame,
cpl_frame *  cen_order_tab_frame,
cpl_frame *  qc_cen_order_tab_frame,
xsh_clipping_param crhclip_par,
xsh_detect_order_param detectorder_par,
xsh_background_param background_par,
const int  pre_overscan_corr,
cpl_frame **  edges_order_tab_frame,
cpl_frame **  master_flat_frame,
cpl_frame **  rmbackground,
cpl_frame **  grid_background,
cpl_frame **  frame_backg,
xsh_instrument instrument 
) [static]
static cpl_error_code xsh_params_bin_scale ( cpl_frameset *  raws,
xsh_background_param backg,
xsh_detect_order_param det_order 
) [static]

Rescale parameters for binning.

Parameters:
raws raw frames set
backg parameters to control inter-order background subtraction
det_order parameters to control order edges detection In case of failure the cpl_error_code is set.

Definition at line 447 of file xsh_mflat.c.

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

Referenced by xsh_mflat().

static cpl_error_code xsh_params_monitor ( xsh_background_param backg,
xsh_detect_order_param det_order 
) [static]
static cpl_error_code xsh_params_set_defaults ( cpl_parameterlist *  pars,
xsh_instrument inst,
xsh_detect_order_param det_order,
xsh_background_param backg 
) [static]

Variable Documentation

char xsh_mflat_description[] [static]

Definition at line 96 of file xsh_mflat.c.

Referenced by cpl_plugin_get_info().

char xsh_mflat_description_short[] [static]
Initial value:
"Create the master flat and the orders edges traces table frames"

Definition at line 93 of file xsh_mflat.c.

Referenced by cpl_plugin_get_info(), and xsh_mflat().


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