xsh_predict
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_predict"
#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer"
#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.
static cpl_error_code xsh_params_set_defaults (cpl_parameterlist *pars, xsh_instrument *inst, xsh_detect_arclines_param *detect_arclines_p)

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"

Definition at line 74 of file xsh_predict.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 75 of file xsh_predict.c.

#define RECIPE_ID   "xsh_predict"

Definition at line 73 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 141 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 cpl_error_code xsh_params_set_defaults ( cpl_parameterlist *  pars,
xsh_instrument inst,
xsh_detect_arclines_param detect_arclines_p 
) [static]
static void xsh_predict ( cpl_parameterlist *  parameters,
cpl_frameset *  frameset 
) [static]
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 183 of file xsh_predict.c.

References assure, check, RECIPE_ID, xsh_error_dump, XSH_GAUSSIAN_METHOD, xsh_init(), xsh_parameters_clipping_detect_arclines_create(), 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 323 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 290 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\
    - [OPTIONAL] A badpixel map (Format = QUP, Tag = BADPIXEL_MAP_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\
    - An arc line list (Format = TABLE, Tag = ARC_LINE_LIST_arm)\n\
    - [UVB,VIS] A master bias (Format = PRE, Tag = MASTER_BIAS_arm)\n\
    - [UVB,VIS] A master dark (Format = PRE, Tag = MASTER_DARK_arm)\n\
  Products : \n\
    - An updated clean arc line list, PRO.CATG=ARC_LINE_LIST_PREDICT_arm.\n\
    - A wavelength solution (Format = TABLE, PRO.CATG = \
WAVE_TAB_GUESS_arm)\n\
    - A residual map, PRO.CATG = RESID_TAB_arm.\n\
    - An order table, PRO.CATG = ORDER_TABLE_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_BIAS_SUBTRACTED_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 98 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 95 of file xsh_predict.c.

Referenced by cpl_plugin_get_info(), and xsh_predict().


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