xsh_linear
[Xshooter Recipes]

Defines

#define RECIPE_ID   "xsh_linear"
#define RECIPE_AUTHOR   "L.Guglielmi,R.Haigron,P.Goldoni,F.Royer"
#define RECIPE_CONTACT   "laurent.guglielmi@apc.univ-paris7.fr"

Functions

static int create (cpl_plugin *plugin)
 Setup the recipe options.
static int exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.
static void xsh_linear (cpl_parameterlist *parameters, cpl_frameset *frameset)
 Interpret the command line options and execute the data processing.
static void xsh_gain (cpl_parameterlist *parameters, cpl_frameset *frameset, xsh_instrument *instr)
 computes detector's gain
static cpl_vector * xsh_get_exptimes (cpl_frameset *set)
 get input frames exposure times
int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.

Variables

static char xsh_linear_description_short []
static char xsh_linear_description []

Detailed Description

This recipe creates a bad pixel mask from a series of linearity exposures See man-page for details.


Define Documentation

#define RECIPE_AUTHOR   "L.Guglielmi,R.Haigron,P.Goldoni,F.Royer"

Definition at line 80 of file xsh_linear.c.

#define RECIPE_CONTACT   "laurent.guglielmi@apc.univ-paris7.fr"

Definition at line 81 of file xsh_linear.c.

#define RECIPE_ID   "xsh_linear"

Definition at line 79 of file xsh_linear.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 138 of file xsh_linear.c.

References create(), destroy(), exec(), RECIPE_AUTHOR, RECIPE_CONTACT, RECIPE_ID, xsh_get_license(), xsh_linear_description, and xsh_linear_description_short.

static int 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 180 of file xsh_linear.c.

References assure, check, RECIPE_ID, xsh_error_dump, xsh_init(), xsh_parameters_decode_bp(), and xsh_parameters_generic().

Referenced by cpl_plugin_get_info().

static int 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 406 of file xsh_linear.c.

References assure, and xsh_free_parameterlist().

Referenced by cpl_plugin_get_info().

static int 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 373 of file xsh_linear.c.

References assure, xsh_error_dump, and xsh_linear().

Referenced by cpl_plugin_get_info().

static void xsh_gain ( cpl_parameterlist *  parameters,
cpl_frameset *  frameset,
xsh_instrument instr 
) [static]
static cpl_vector * xsh_get_exptimes ( cpl_frameset *  set  )  [static]

get input frames exposure times

Parameters:
set input frameset In case of failure the cpl_error_code is set.

Definition at line 990 of file xsh_linear.c.

References check, n, xsh_free_propertylist(), and xsh_pfits_get_exptime().

Referenced by xsh_gain().

static void xsh_linear ( cpl_parameterlist *  parameters,
cpl_frameset *  frameset 
) [static]

Variable Documentation

char xsh_linear_description[] [static]
Initial value:
  "This recipe creates a bad pixel mask from several (at least 3x3)\n\
 LINEARITY  frames in increasing exposure times\n\
Input Frames:\n\
  Raw Frames (Tag = LINEARITY_arm)\n\
Prepare PRE structures\n\
Group frames by exposure time\n\
Remove cosmic rays in each group and create\n\
 the median frame\n\
Finally compute the linearity bad pixel mask. Linearity is obtained by\n\
 a polynomial fit (degree 3)\n\
Product:\n\
  Bad Pixel Map, PRO.CATG = BADPIXEL_MAP_arm\n"

Definition at line 110 of file xsh_linear.c.

Referenced by cpl_plugin_get_info().

Initial value:
  "Create the linearity bad pixel mask"

Definition at line 107 of file xsh_linear.c.

Referenced by cpl_plugin_get_info(), and xsh_linear().


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