fors_recipe Recipe


Defines

#define cleanup

Functions

void fors_img_sky_flat_define_parameters (cpl_parameterlist *parameters)
 Define recipe parameters.
void fors_img_sky_flat (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_img_sky_flat_create (cpl_plugin *plugin)
 Setup the recipe options.
static int fors_img_sky_flat_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int fors_img_sky_flat_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.

Variables

const char *const fors_img_sky_flat_name = "fors_img_sky_flat"
const char *const fors_img_sky_flat_description_short = "Compute master img_sky_flat frame"
const char *const fors_img_sky_flat_author = "Jonas M. Larsen"
const char *const fors_img_sky_flat_email = PACKAGE_BUGREPORT
const char *const fors_img_sky_flat_description

Detailed Description

See recipe description for details.

Define Documentation

#define cleanup

Value:

do { \
    cpl_frameset_delete(sflat_frames); \
    cpl_frameset_delete(master_bias_frame); \
    fors_stack_method_delete(&sm); \
    cpl_free((void *)context); \
    fors_image_delete_const(&master_bias); \
    fors_image_delete(&master_sky_flat); \
    fors_image_list_delete(&sflats, fors_image_delete); \
    cpl_propertylist_delete(qc); \
    fors_setting_delete(&setting); \
} while (0)

Definition at line 77 of file fors_img_sky_flat_impl.c.


Function Documentation

void fors_img_sky_flat_define_parameters ( cpl_parameterlist *  parameters  ) 

Define recipe parameters.

Parameters:
parameters parameter list to fill

Definition at line 65 of file fors_img_sky_flat_impl.c.

References fors_img_sky_flat_name, and fors_stack_define_parameters().

Referenced by fors_img_sky_flat_create(), and test_img_sky_flat().

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

Do the processing.

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

Definition at line 98 of file fors_img_sky_flat_impl.c.

References assure, cleanup, fors_dfs_save_image(), fors_frameset_extract(), fors_image_divide_scalar(), fors_image_get_median(), fors_image_load(), fors_image_load_list(), fors_img_sky_flat_name, fors_qc_dic_version, fors_qc_end_group(), fors_qc_start_group(), fors_qc_write_group_heading(), fors_qc_write_qc_double(), fors_setting_new(), fors_stack(), fors_stack_method_new(), and _fors_setting::instrument.

Referenced by fors_img_sky_flat_exec(), and test_img_sky_flat().

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_img_sky_flat.c.

References fors_get_version_binary(), fors_img_sky_flat_author, fors_img_sky_flat_create(), fors_img_sky_flat_description, fors_img_sky_flat_description_short, fors_img_sky_flat_destroy(), fors_img_sky_flat_email, fors_img_sky_flat_exec(), fors_img_sky_flat_name, and fors_license.

static int fors_img_sky_flat_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_img_sky_flat.c.

References fors_img_sky_flat_define_parameters().

Referenced by cpl_plugin_get_info().

static int fors_img_sky_flat_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_img_sky_flat.c.

References fors_begin(), fors_end(), fors_img_sky_flat(), and fors_img_sky_flat_description_short.

Referenced by cpl_plugin_get_info().

static int fors_img_sky_flat_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_img_sky_flat.c.

Referenced by cpl_plugin_get_info().


Variable Documentation

const char* const fors_img_sky_flat_description

Initial value:

 
"Input files:\n"
"  DO category:               Type:       Explanation:             Number:\n"
"  SKY_FLAT_IMG               Raw         Jittered sky flat fields    1+\n"
"  MASTER_BIAS                FITS image  Master bias                 1\n"
"\n"
"Output files:\n"
"  DO category:               Data type:  Explanation:\n"
"  MASTER_SKY_FLAT_IMG        FITS image  Master sky flat field\n"

Definition at line 51 of file fors_img_sky_flat_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