xsh_mbias
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_mbias"
#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_mbias_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_mbias_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_mbias_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_mbias (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_mbias_description_short [] = "Create the master bias frame"
static char xsh_mbias_description []

Detailed Description

This recipe calculates the master bias frame 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 77 of file xsh_mbias.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 78 of file xsh_mbias.c.

#define RECIPE_ID   "xsh_mbias"

Definition at line 76 of file xsh_mbias.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 124 of file xsh_mbias.c.

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_mbias_create(), xsh_mbias_description, xsh_mbias_description_short, xsh_mbias_destroy(), and xsh_mbias_exec().

static void xsh_mbias ( 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 285 of file xsh_mbias.c.

References check, instrument, RECIPE_ID, xsh_stack_param::stack_method, xsh_add_product_pre(), xsh_begin(), XSH_BIAS, xsh_check_load_master_bpmap(), xsh_compute_qc_on_master_bias(), xsh_create_master_bias2(), xsh_end(), xsh_free_frame(), xsh_free_frameset(), xsh_free_propertylist(), XSH_GET_TAG_FROM_ARM, xsh_instrument_free(), XSH_MASTER_BIAS, xsh_mbias_description_short, xsh_msg, xsh_prepare(), xsh_recipe_params_check(), and xsh_stack_frames_get().

Referenced by xsh_mbias_exec().

static int xsh_mbias_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 166 of file xsh_mbias.c.

References assure, check, DECODE_BP_FLAG_DEF, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_decode_bp(), xsh_parameters_fpn_create(), xsh_parameters_generic(), xsh_parameters_ron_create(), xsh_parameters_stack_create(), and xsh_parameters_struct_create().

Referenced by cpl_plugin_get_info().

static int xsh_mbias_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 249 of file xsh_mbias.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_mbias_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 216 of file xsh_mbias.c.

References assure, xsh_error_dump, and xsh_mbias().

Referenced by cpl_plugin_get_info().


Variable Documentation

char xsh_mbias_description[] [static]
Initial value:
    "This recipe creates a master bias frame by computing the median of all \
input bias frames.\n\
Input Frames : \n\
  - A set of n RAW frames (Format=RAW, n >=3, Tag = BIAS_arm)\n\
  - [OPTIONAL] A map of non linear bad pixels (Format=QUP, Tag = BP_MAP_NL_arm)\n\
  - [OPTIONAL] A map of reference bad pixels (Format = QUP,RAW, Tag = BP_MAP_RP_arm)\n\
Products : \n\
  - A master bias frame (Format=PRE, PRO.CATG = MASTER_BIAS_arm)\n"

Definition at line 100 of file xsh_mbias.c.

Referenced by cpl_plugin_get_info().

char xsh_mbias_description_short[] = "Create the master bias frame" [static]

Definition at line 98 of file xsh_mbias.c.

Referenced by cpl_plugin_get_info(), and xsh_mbias().


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