xsh_predict
[Xshooter Recipes]

Defines

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

Functions

static int xsh_predict_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_predict_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_predict_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_predict (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.

Variables

static char xsh_predict_description_short []
static char xsh_predict_description []

Detailed Description

This recipe is used to obtain a first guess dispersion solution and order table. It calculates the geometry of the spectral format from a physical model and compares the predicted line positions to the ones on the calibration frame See man-page for details.


Define Documentation

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

Definition at line 84 of file xsh_predict.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 85 of file xsh_predict.c.

#define RECIPE_ID   "xsh_predict"

Definition at line 83 of file xsh_predict.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 153 of file xsh_predict.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_predict_create(), xsh_predict_description, xsh_predict_description_short, xsh_predict_destroy(), and xsh_predict_exec().

static void xsh_predict ( 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 369 of file xsh_predict.c.

References check, exptime, instrument, RECIPE_ID, xsh_add_product_image(), xsh_add_product_table(), xsh_add_temporary_file(), XSH_ARC_LINE_LIST_INTMON, XSH_ARM_NIR, XSH_ARM_UVB, XSH_ASSURE_NOT_ILLEGAL_MSG, xsh_begin(), xsh_check_input_is_unbinned(), xsh_check_load_master_bpmap(), xsh_create_order_table(), xsh_detect_arclines_dan(), XSH_DETECT_ARCLINES_TYPE_MODEL, XSH_DETECT_ARCLINES_TYPE_POLY, xsh_dfs_split_nir(), xsh_end(), xsh_error_reset, xsh_find_arc_line_list(), xsh_find_frame_with_tag(), XSH_FMTCHK, xsh_frame_table_resid_merge(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), xsh_free_table(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), xsh_instrument_set_mode(), xsh_instrument_update_from_spectralformat(), XSH_MASTER_BIAS, XSH_MASTER_DARK, XSH_MOD_CFG_OPT_REC, XSH_MOD_CFG_TAB, xsh_mode_is_physmod(), XSH_MODE_SLIT, xsh_model_pipe_anneal(), xsh_msg, xsh_msg_warning, XSH_ORDER_TAB_RECOV, xsh_parameters_clipping_detect_arclines_get(), xsh_parameters_detect_arclines_get(), xsh_parameters_get_int(), xsh_pfits_get_exptime(), xsh_predict_description_short, xsh_prepare(), xsh_recipe_params_check(), XSH_RESID_TAB_TABLE_COLNAME_XGAUSS, XSH_RESID_TAB_TABLE_COLNAME_XTHANNEAL, XSH_RESID_TAB_TABLE_COLNAME_XTHPRE, XSH_SOLUTION_RELATIVE, XSH_SPECTRAL_FORMAT, xsh_stringcat_any(), xsh_subtract_bias(), xsh_subtract_dark(), xsh_subtract_nir_on_off(), XSH_THEO_TAB_SING, XSH_WAVE_TAB_GUESS, xsh_wavecal_qclog_intmon(), and xsh_wavetab_qc().

Referenced by xsh_predict_exec().

static int xsh_predict_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 195 of file xsh_predict.c.

References assure, check, DECODE_BP_FLAG_DEF, RECIPE_ID, xsh_error_dump, XSH_GAUSSIAN_METHOD, xsh_init(), xsh_parameters_clipping_detect_arclines_create(), xsh_parameters_decode_bp(), xsh_parameters_detect_arclines_create(), xsh_parameters_generic(), xsh_parameters_new_double(), xsh_parameters_new_int(), and xsh_parameters_pre_overscan().

Referenced by cpl_plugin_get_info().

static int xsh_predict_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 334 of file xsh_predict.c.

References assure, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_predict_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 301 of file xsh_predict.c.

References assure, xsh_error_dump, and xsh_predict().

Referenced by cpl_plugin_get_info().


Variable Documentation

char xsh_predict_description[] [static]
Initial value:
"This recipe creates a wavelength solution and an order table.\n\
  Input Frames :\n\
    - [UVB, VIS] One RAW frame (Format = RAW, Tag = FMTCHK_arm)\n\
    - [NIR] Two RAW frames ((Format = RAW,  Tag = FMTCHK_arm_ON,\
FMTCHK_arm_OFF)\n\
    - A spectral format table (Format = PRE, Tag = SPECTRAL_FORMAT_TAB_arm)\n\
    - An arc line list (Format = TABLE, Tag = ARC_LINE_LIST_arm)\n\
    - [UVB,VIS,OPTIONAL] A master bias (Format = PRE, Tag = MASTER_BIAS_arm)\n\
    - [UVB,VIS,OPTIONAL] A master dark (Format = PRE, Tag = MASTER_DARK_arm)\n\
    - [OPTIONAL] A reference badpixel map (Format = QUP, Tag = BP_MAP_RP_arm)\n\
    - [OPTIONAL] A non-linear badpixel map (Format = QUP, Tag = BP_MAP_NL_arm)\n\
    - [OPTIONAL] Reference list to monitor line intensity (Tag = ARC_LINE_LIST_INTMON_arm)\n \
    - [poly mode] A theoretical map (Format = TABLE, Tag = THEO_TAB_SING_arm)\n\
    - [physical model mode] A model cfg table (Format = TABLE, Tag = XSH_MOD_CFG_TAB_arm)\n\
  Products : \n\
    - [poly mode] A wavelength solution (Format = TABLE, PRO.CATG = \
WAVE_TAB_GUESS_arm)\n\
    - An order table, PRO.CATG = ORDER_TAB_GUESS_arm\n\
      (if at least degree+1 points are found in each order).\n  \
    - A line identification residual table, PRO.CATG = FMTCHK_RESID_TAB_LINES_arm\n\
    - The bias subtracted formatcheck frame, PRO.CATG = FMTCHK_ON_arm\n\
    - [physical model mode]An optimized model configuration table, PRO.CATG = XSH_MOD_CFG_OPT_FMT_ARM\n\
  Prepare the frames.\n\
  For UVB,VIS :\n\
    Subtract Master Bias.\n\
    Subtract Master Dark\n\
  For NIR:\n\
    Subtract ON OFF\n\
  Compute guess order table and wavelength solution\n"

Definition at line 108 of file xsh_predict.c.

Referenced by cpl_plugin_get_info().

Initial value:
"Compute a first guess dispersion solution and order table"

Definition at line 105 of file xsh_predict.c.

Referenced by cpl_plugin_get_info(), and xsh_predict().


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