FORS Pipeline Reference Manual 4.9.9
Defines | Functions | Variables
fors_recipe Recipe

Defines

#define cleanup
#define cleanup
#define cleanup
#define cleanup

Functions

static double get_image_quality (const fors_star_list *sources, double *image_quality_err, double *stellarity, double *ellipticity, double *ellipticity_rms)
 Compute image quality.
void fors_img_science_define_parameters (cpl_parameterlist *parameters)
 Define recipe parameters.
void fors_img_science (cpl_frameset *frames, const cpl_parameterlist *parameters)
 Do the processing.
static bool is_star (const fors_star *s, void *data)
 Determine if source is a star.
int cpl_plugin_get_info (cpl_pluginlist *list)
 Build the list of available plugins, for this module.
static int fors_img_science_create (cpl_plugin *plugin)
 Setup the recipe options.
static int fors_img_science_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int fors_img_science_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.

Variables

const char *const fors_img_science_name = "fors_img_science"
const char *const fors_img_science_description_short = "Reduce scientific exposure"
const char *const fors_img_science_author = "Jonas M. Larsen"
const char *const fors_img_science_email = PACKAGE_BUGREPORT
const char *const fors_img_science_description = " OBJECT_TABLE_SCI_IMG FITS table Extracted sources properties\n"

Detailed Description

See recipe description for details.


Define Documentation

#define cleanup
Value:
do { \
    cpl_free((void *)full_name); \
} while (0)

Definition at line 512 of file fors_img_science_impl.c.

#define cleanup
Value:
do { \
    cpl_frameset_delete(sci_frame); \
    cpl_frameset_delete(master_bias_frame); \
    cpl_frameset_delete(master_flat_frame); \
    fors_image_delete(&sci); \
    fors_image_delete_const(&master_bias); \
    fors_image_delete(&master_flat); \
    cpl_table_delete(phot); \
    cpl_table_delete(sources); \
    cpl_image_delete(background); \
    fors_extract_method_delete(&em); \
    fors_star_list_delete(&stars, fors_star_delete); \
    cpl_free((void *)context); \
    fors_setting_delete(&setting); \
    cpl_propertylist_delete(qc); \
    cpl_propertylist_delete(product_header); \
    cpl_propertylist_delete(header); \
} while (0)

Definition at line 512 of file fors_img_science_impl.c.

#define cleanup
Value:
do { \
    fors_star_list_delete(&stars, fors_star_delete); \
} while(0)

Definition at line 512 of file fors_img_science_impl.c.


Function Documentation

static double get_image_quality ( const fors_star_list *  sources,
double *  image_quality_err,
double *  stellarity,
double *  ellipticity,
double *  ellipticity_rms 
) [static]

Compute image quality.

Parameters:
sourcesextracted sources
image_quality_err(output) empirical scatter (based on median absolute deviation)
stellarity(output) average stellarity of sources above stellarity cutoff
ellipticity(output) average ellipticity of sources above stellarity cutoff
ellipticity_rms(output) RMS ellipticity of sources above stellarity cutoff
mediansource extension (in the one sigma sense)

Definition at line 530 of file fors_img_science_impl.c.

References fors_star_duplicate(), fors_star_ellipticity(), fors_star_extension(), fors_star_stellarity(), and is_star().

Referenced by fors_img_science().

void fors_img_science_define_parameters ( cpl_parameterlist *  parameters)

Define recipe parameters.

Parameters:
parametersparameter list to fill

Definition at line 89 of file fors_img_science_impl.c.

References fors_extract_define_parameters().

Referenced by fors_img_science_create(), and test_img_science().

void fors_img_science ( cpl_frameset *  frames,
const cpl_parameterlist *  parameters 
)
static bool is_star ( const fors_star s,
void *  data 
) [static]

Determine if source is a star.

Parameters:
ssources
datanot used
Returns:
true iff the source is more star-like

Definition at line 500 of file fors_img_science_impl.c.

References assure.

Referenced by get_image_quality().

int cpl_plugin_get_info ( cpl_pluginlist *  list)

Build the list of available plugins, for this module.

Parameters:
listThe 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_science.c.

References fors_get_license(), fors_get_version_binary(), fors_img_science_create(), fors_img_science_destroy(), and fors_img_science_exec().

static int fors_img_science_create ( cpl_plugin *  plugin) [static]

Setup the recipe options.

Parameters:
pluginThe plugin
Returns:
0 if everything is ok

Defining the command-line/configuration parameters for the recipe.

Definition at line 109 of file fors_img_science.c.

References fors_img_science_define_parameters().

Referenced by cpl_plugin_get_info().

static int fors_img_science_exec ( cpl_plugin *  plugin) [static]

Execute the plugin instance given by the interface.

Parameters:
pluginthe plugin
Returns:
0 if everything is ok

Definition at line 158 of file fors_img_science.c.

References fors_begin(), fors_end(), and fors_img_science().

Referenced by cpl_plugin_get_info().

static int fors_img_science_destroy ( cpl_plugin *  plugin) [static]

Destroy what has been created by the 'create' function.

Parameters:
pluginThe plugin
Returns:
0 if everything is ok

Definition at line 207 of file fors_img_science.c.

Referenced by cpl_plugin_get_info().