xsh_mdark
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_mdark"
#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_mdark_create (cpl_plugin *plugin)
 Setup the recipe options.
static int xsh_mdark_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int xsh_mdark_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_mdark (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)
static cpl_frame * xsh_get_master_dark_nir_via_noise (cpl_imagelist *dataList, cpl_frame *medFrame, cpl_parameterlist *parameters, xsh_clipping_param *noise_clipping, xsh_instrument *instrument, cpl_frame **noisyFrame)
static cpl_frame * xsh_get_master_dark_opt (cpl_frame *medFrame, cpl_frame *master_bias, cpl_parameterlist *parameters, cpl_frame *crh_frm, cpl_frame *bp_map_noise_frm, xsh_instrument *instrument, const int pre_overscan_corr)
static cpl_frame * xsh_get_crh_frame (cpl_image *crh_ima, xsh_instrument *instrument)

Variables

static char xsh_mdark_description_short []
static char xsh_mdark_description []

Detailed Description

This recipe calculates the master dark 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 72 of file xsh_mdark.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 73 of file xsh_mdark.c.

#define RECIPE_ID   "xsh_mdark"

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

References RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_mdark_create(), xsh_mdark_description, xsh_mdark_description_short, xsh_mdark_destroy(), and xsh_mdark_exec().

static cpl_frame* xsh_get_crh_frame ( cpl_image *  crh_ima,
xsh_instrument instrument 
) [static]
static cpl_frame* xsh_get_master_dark_nir_via_noise ( cpl_imagelist *  dataList,
cpl_frame *  medFrame,
cpl_parameterlist *  parameters,
xsh_clipping_param noise_clipping,
xsh_instrument instrument,
cpl_frame **  noisyFrame 
) [static]
static cpl_frame* xsh_get_master_dark_opt ( cpl_frame *  medFrame,
cpl_frame *  master_bias,
cpl_parameterlist *  parameters,
cpl_frame *  crh_frm,
cpl_frame *  bp_map_noise_frm,
xsh_instrument instrument,
const int  pre_overscan_corr 
) [static]

Definition at line 415 of file xsh_mdark.c.

References check, check_msg, xsh_create_master_dark(), xsh_msg, and xsh_subtract_bias().

Referenced by xsh_mdark().

static void xsh_mdark ( cpl_parameterlist *  parameters,
cpl_frameset *  frameset 
) [static]
static int xsh_mdark_create ( cpl_plugin *  plugin  )  [static]
static int xsh_mdark_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 291 of file xsh_mdark.c.

References assure, xsh_error_reset, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int xsh_mdark_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 257 of file xsh_mdark.c.

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

Referenced by cpl_plugin_get_info().

static cpl_error_code xsh_params_set_defaults ( cpl_parameterlist *  pars,
xsh_instrument inst 
) [static]

Definition at line 319 of file xsh_mdark.c.

References check, RECIPE_ID, XSH_ARM_NIR, xsh_instrument_get_arm(), and xsh_parameters_find().

Referenced by xsh_mdark().


Variable Documentation

char xsh_mdark_description[] [static]
Initial value:
"This recipe creates a master dark frame\n\
Input Frames : \n\
  - A set of n RAW frames (Format=RAW, n >=3, Tag = DARK_arm)\n\
  - [UVB,VIS] A master bias frame (Format=PRE, Tag = MASTER_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 dark frame (Format=PRE, PRO.CATG = MASTER_DARK_arm)\n\
    A dark frame, (Format=PRE, PRO.CATG = DARK_arm)\n"

Definition at line 96 of file xsh_mdark.c.

Referenced by cpl_plugin_get_info().

char xsh_mdark_description_short[] [static]
Initial value:
"Create the master dark frame"

Definition at line 93 of file xsh_mdark.c.

Referenced by cpl_plugin_get_info(), and xsh_mdark().


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