fors_recipe Recipe


Defines

#define cleanup

Functions

void fors_dark_define_parameters (cpl_parameterlist *parameters)
 Define recipe parameters.
void fors_dark (cpl_frameset *frames, const cpl_parameterlist *parameters)
 Do the processing.
int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.
static int fors_dark_create (cpl_plugin *plugin)
 Setup the recipe options.
static int fors_dark_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int fors_dark_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.

Variables

const char *const fors_dark_name = "fors_dark"
const char *const fors_dark_description_short = "Compute master dark frame"
const char *const fors_dark_author = "Jonas M. Larsen"
const char *const fors_dark_email = PACKAGE_BUGREPORT
const char *const fors_dark_description

Detailed Description

See recipe description for details.

Define Documentation

#define cleanup

Value:

do { \
    cpl_frameset_delete(dark_frames); \
    cpl_frameset_delete(master_bias_frame); \
    fors_image_delete_const(&master_bias); \
    fors_stack_method_delete(&sm); \
    fors_image_delete(&master_dark); \
    fors_image_list_delete_const(&darks, fors_image_delete); \
    fors_setting_delete(&setting); \
    cpl_free((void *)context); \
} while (0)

Definition at line 83 of file fors_dark_impl.c.


Function Documentation

void fors_dark_define_parameters ( cpl_parameterlist *  parameters  ) 

Define recipe parameters.

Parameters:
parameters parameter list to fill

Definition at line 71 of file fors_dark_impl.c.

References fors_dark_name, and fors_stack_define_parameters().

Referenced by fors_dark_create(), and test_dark().

void fors_dark ( cpl_frameset *  frames,
const cpl_parameterlist *  parameters 
)

Do the processing.

Parameters:
frames input frames
parameters parameters
Returns:
0 if everything is ok

Definition at line 103 of file fors_dark_impl.c.

References assure, cleanup, fors_dark_name, fors_dfs_save_image(), fors_frameset_extract(), fors_image_load(), fors_image_load_list_const(), fors_setting_new(), fors_stack_const(), and fors_stack_method_new().

Referenced by fors_dark_exec(), and test_dark().

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 62 of file fors_dark.c.

References fors_dark_author, fors_dark_create(), fors_dark_description, fors_dark_description_short, fors_dark_destroy(), fors_dark_email, fors_dark_exec(), fors_dark_name, fors_get_version_binary(), and fors_license.

static int fors_dark_create ( cpl_plugin *  plugin  )  [static]

Setup the recipe options.

Parameters:
plugin The plugin
Returns:
0 if everything is ok
Defining the command-line/configuration parameters for the recipe.

Definition at line 109 of file fors_dark.c.

References fors_dark_define_parameters().

Referenced by cpl_plugin_get_info().

static int fors_dark_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 158 of file fors_dark.c.

References fors_begin(), fors_dark(), fors_dark_description_short, and fors_end().

Referenced by cpl_plugin_get_info().

static int fors_dark_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 207 of file fors_dark.c.

Referenced by cpl_plugin_get_info().


Variable Documentation

const char* const fors_dark_description

Initial value:

"This recipe is used to combine input raw DARK frames into a master dark\n"
"frame by subtracing the master bias and using the given stacking method.\n"
"The overscan regions, if present, are removed from the result.\n"
"\n"
"Input files:\n"
"\n"
"  DO category:               Type:       Explanation:         Required:\n"
"  DARK                       Raw         Dark frame              Y\n"
"  MASTER_BIAS                FITS image  Master bias             Y\n"
"\n"
"Output files:\n"
"\n"
"  DO category:               Data type:  Explanation:\n"
"  MASTER_DARK                FITS image  Master dark frame\n"
"\n"

Definition at line 50 of file fors_dark_impl.c.

Referenced by cpl_plugin_get_info().


Generated on Fri Mar 4 09:46:01 2011 for FORS Pipeline Reference Manual by  doxygen 1.4.7