xsh_mdark
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_mdark"
#define RECIPE_AUTHOR   "P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, 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)

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, A. Modigliani"

Definition at line 70 of file xsh_mdark.c.

#define RECIPE_CONTACT   "amodigli@eso.org"

Definition at line 71 of file xsh_mdark.c.

#define RECIPE_ID   "xsh_mdark"

Definition at line 69 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 123 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 void xsh_mdark ( 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 340 of file xsh_mdark.c.

References binx, biny, check, check_msg, crh_clipping, xsh_clipping_param::diff, xsh_clipping_param::frac, instrument, llx, lly, xsh_clipping_param::niter, QFLAG_HOT_PIXEL, RECIPE_ID, xsh_clipping_param::sigma, urx, ury, xsh_add_product_bpmap(), xsh_add_product_image(), xsh_add_product_pre(), xsh_add_temporary_file(), XSH_ARM_NIR, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, xsh_badpixelmap_coadd(), xsh_begin(), XSH_BP_MAP_NP, XSH_BP_MAP_PN, xsh_bpmap_mask_bad_pixel(), xsh_check_load_master_bpmap(), xsh_compute_noise_map(), xsh_create_master_bpmap(), xsh_create_master_dark(), XSH_CRH_MAP, XSH_DARK, XSH_DRS_MDARK, xsh_end(), xsh_find_frame_with_tag(), xsh_frame_product(), XSH_FREE, xsh_free_frame(), xsh_free_frameset(), xsh_free_image(), xsh_free_imagelist(), xsh_free_mask(), xsh_free_parameterlist(), xsh_free_propertylist(), xsh_free_table(), XSH_GET_TAG_FROM_ARM, xsh_image_search_bad_pixels_via_noise(), xsh_instrument_arm_tostring(), xsh_instrument_free(), xsh_instrument_get_arm(), XSH_MASTER_BIAS, XSH_MASTER_BP_MAP, xsh_mdark_description_short, xsh_msg, xsh_msg_dbg_low, xsh_msg_dbg_medium, xsh_msg_error, xsh_msg_warning, xsh_parameters_clipping_crh_get(), xsh_parameters_clipping_noise_get(), xsh_parameters_create_from_drs_table(), xsh_parameters_get_boolean(), xsh_parameters_get_int(), xsh_params_set_defaults(), xsh_pfits_get_binx(), xsh_pfits_get_biny(), xsh_pfits_set_pcatg(), XSH_PREFIX, xsh_prepare(), xsh_remove_crh_multiple(), and xsh_subtract_bias().

Referenced by xsh_mdark_exec().

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

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_clipping_crh_create(), xsh_parameters_clipping_noise_create(), xsh_parameters_fpn_create(), xsh_parameters_generic(), xsh_parameters_new_boolean(), xsh_parameters_new_double(), xsh_parameters_pre_overscan(), xsh_parameters_ref1_create(), and xsh_parameters_ron_dark_create().

Referenced by cpl_plugin_get_info().

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 282 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 248 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]

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 badpixel map (Format=QUP, Tag = MASTER_BP_MAP_arm)\n\
  - [OPTIONAL] A map of non linear pixel (Format = QUP,RAW, Tag = BP_MAP_NL_arm)\n\
Products : \n\
  - A map frame containing CRHs  (PRO.CATG = CRH_MAP_arm)\n\
  - A master dark frame (Format=PRE, PRO.CATG = MASTER_DARK_arm)\n\
  - [VIS && bp-output=yes] A badpixel map (Format=QUP, \n\
    PRO.CATG = MASTER_BP_MAP_arm)\n\
  - If an input master bad pixel map or a map of non linear pixels is provided \n\
    A master bad pixel map image, PRO.CATG = MASTER_BP_MAP_arm\n"

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

Referenced by cpl_plugin_get_info(), and xsh_mdark().


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