fors_recipe Recipe


Defines

#define cleanup
#define cleanup

Functions

static void write_qc (cpl_propertylist *qc, const fors_setting *setting, const cpl_frame *first_bias, const fors_image_list *bias, const fors_image *master_bias, const stack_method *sm)
void fors_bias_define_parameters (cpl_parameterlist *parameters)
 Define recipe parameters.
void fors_bias (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_bias_create (cpl_plugin *plugin)
 Setup the recipe options.
static int fors_bias_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int fors_bias_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.

Variables

const char *const fors_bias_name = "fors_bias"
const char *const fors_bias_description_short = "Compute the master bias frame"
const char *const fors_bias_author = "Jonas M. Larsen, Carlo Izzo"
const char *const fors_bias_email = PACKAGE_BUGREPORT
const char *const fors_bias_description

Detailed Description

See recipe description for details.

Define Documentation

#define cleanup

Value:

do { \
    cpl_frameset_delete(bias_frames); \
    fors_stack_method_delete(&sm); \
    cpl_free((void *)context); \
    fors_image_list_delete_const(&bias, fors_image_delete); \
    fors_image_delete(&master_bias); \
    fors_setting_delete(&setting); \
    cpl_propertylist_delete(qc); \
} while (0)

Definition at line 165 of file fors_bias_impl.c.

Referenced by build_equations_lhs_matrix_from_parameters(), build_equations_rhs_cov(), create_bias(), create_dark(), create_phot_table(), create_screen_flat(), create_sky_flat(), create_std_cat(), extract_sex(), fors_bias(), fors_dark(), fors_dfs_add_exptime(), fors_dfs_add_wcs(), fors_extract_method_new(), fors_fixed_pattern_noise(), fors_fixed_pattern_noise_bias(), fors_identify(), fors_image_collapse_create(), fors_image_collapse_ksigma_create(), fors_image_collapse_median_create(), fors_image_collapse_minmax_create(), fors_image_divide(), fors_image_flat_fit_create(), fors_image_get_stdev_robust(), fors_image_load(), fors_image_load_list(), fors_image_multiply(), fors_image_save(), fors_image_save_sex(), fors_image_subtract(), fors_img_science(), fors_img_screen_flat(), fors_img_sky_flat(), fors_photometry(), fors_photometry_define_polyf(), fors_photometry_define_polyp(), fors_photometry_poly_new_from_coefficients(), fors_photometry_read_input(), fors_photometry_remove_unnecessary(), fors_polynomial_count_coeff(), fors_polynomial_create_variance_polynomial(), fors_polynomial_dump(), fors_polynomial_powers_find_first_coeff(), fors_polynomial_powers_find_next_coeff(), fors_polynomial_set_existing_coeff(), fors_qc_write_group_heading(), fors_setting_new_level(), fors_setting_verify(), fors_stack_method_new(), fors_star_ext_corr(), fors_zeropoint(), fors_zeropoint_astrometry(), fors_zeropoint_astrometry_apply_unidentified_xy2radec(), fors_zeropoint_astrometry_get_wcs_shift_px(), fors_zeropoint_astrometry_shift_wcs_origin(), get_image_quality(), get_zeropoint(), match_patterns(), mos_photometric_calibration(), remove_large_scale(), remove_large_scale_fit(), solve_normal(), test_bias(), test_dark(), test_divide(), test_exponential(), test_identify(), test_image(), test_img_science(), test_img_screen_flat(), test_img_sky_flat(), test_new(), test_photometry(), test_recipe_output(), test_setting(), test_stack(), test_star(), test_subtract(), test_zeropoint(), and write_qc().

#define cleanup

Value:

do { \
    fors_image_delete(&image); \
} while (0)

Definition at line 165 of file fors_bias_impl.c.


Function Documentation

void fors_bias_define_parameters ( cpl_parameterlist *  parameters  ) 

Define recipe parameters.

Parameters:
parameters parameter list to fill

Definition at line 78 of file fors_bias_impl.c.

References fors_bias_name, and fors_stack_define_parameters().

Referenced by fors_bias_create(), and test_bias().

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

Do the processing.

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

Definition at line 109 of file fors_bias_impl.c.

References assure, cleanup, fors_bias_name, fors_dfs_save_image(), fors_frameset_extract(), fors_image_load_list_const(), fors_setting_new(), fors_stack_const(), fors_stack_method_new(), and write_qc().

Referenced by fors_bias_exec(), and test_bias().

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

References fors_bias_author, fors_bias_create(), fors_bias_description, fors_bias_description_short, fors_bias_destroy(), fors_bias_email, fors_bias_exec(), fors_bias_name, fors_get_version_binary(), and fors_license.

static int fors_bias_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_bias.c.

References fors_bias_define_parameters().

Referenced by cpl_plugin_get_info().

static int fors_bias_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_bias.c.

References fors_begin(), fors_bias(), fors_bias_description_short, and fors_end().

Referenced by cpl_plugin_get_info().

static int fors_bias_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_bias.c.

Referenced by cpl_plugin_get_info().


Variable Documentation

const char* const fors_bias_description

Initial value:

"This recipe is used to combine input raw BIAS frames into a master bias\n"
"frame. The overscan regions, if present, are removed from the result.\n\n"
"Input files:\n\n"
"  DO category:               Type:       Explanation:         Required:\n"
"  BIAS                       Raw         Bias frame              Y\n\n"
"Output files:\n\n"
"  DO category:               Data type:  Explanation:\n"
"  MASTER_BIAS                FITS image  Master bias frame\n\n"

Definition at line 56 of file fors_bias_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