fors_recipe Recipe


Data Structures

struct  entry

Defines

#define LIST_ELEM   entry
#define LIST_DEFINE
#define cleanup
#define cleanup
#define cleanup

Functions

static entry_list * read_input (const cpl_frameset *aligned_phot_frames, const fors_setting *setting, bool override_fit_m, int *n, int *nfit, int *m, bool **fit_mag, fors_std_star_list **to_be_destroyed)
static void build_equations (const entry_list *obs, bool fit_z, bool fit_c, bool fit_x, int degreef1, int degreef2, int degreep, int n, int m, int n_parameters, const bool *fit_mag, double ext_coeff, double dext_coeff, double dcolor_coeff, cpl_matrix **A, cpl_matrix **M, cpl_matrix **covarianceM)
entryentry_new (int frame_number, int star_number, double airmass, double gain, double exptime, fors_star *star, bool fit_mag)
 entry constructor
void entry_delete (entry **e)
 Destructor.
static void entry_delete_but_standard (entry **e)
 Destructor.
void entry_list_print (const entry_list *l, cpl_msg_severity level)
 Print list.
void fors_photometry_define_parameters (cpl_parameterlist *parameters)
 Define recipe parameters.
static void myprintf (const char *format,...)
static cpl_matrix * matrix_product_normal_create (const cpl_matrix *self)
static cpl_matrix * solve_normal (const cpl_matrix *coeff, const cpl_matrix *rhs, const cpl_matrix *cov_rhs, double *red_chisq)
void fors_photometry (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_photometry_create (cpl_plugin *plugin)
 Setup the recipe options.
static int fors_photometry_exec (cpl_plugin *plugin)
 Execute the plugin instance given by the interface.
static int fors_photometry_destroy (cpl_plugin *plugin)
 Destroy what has been created by the 'create' function.

Variables

const char *const fors_photometry_name = "fors_photometry"
const char *const fors_photometry_description_short = "Compute corrected flatfield"
const char *const fors_photometry_author = "Jonas M. Larsen"
const char *const fors_photometry_email = PACKAGE_BUGREPORT
const char *const fors_photometry_description
const double arcsec_tol = 5.0

Detailed Description

See recipe description for details.

Define Documentation

#define cleanup
 

Value:

do { \
    cpl_frameset_delete((cpl_frameset *)aligned_phot_frames);   \
    cpl_frameset_delete((cpl_frameset *)master_flat_frame); \
    cpl_frameset_delete((cpl_frameset *)phot_table); \
    fors_setting_delete(&setting); \
    fors_image_delete(&master_flat); \
    fors_image_delete(&correction); \
} while (0)

Definition at line 1078 of file fors_photometry_impl.c.


Function Documentation

entry* entry_new int  frame_number,
int  star_number,
double  airmass,
double  gain,
double  exptime,
fors_star star,
bool  fit_mag
 

entry constructor

Parameters:
star ownership is transferred, so deallocate only using entry_delete

Definition at line 117 of file fors_photometry_impl.c.

void entry_delete entry **  e  ) 
 

Destructor.

Parameters:
e to delete

Definition at line 140 of file fors_photometry_impl.c.

References fors_star_delete().

static void entry_delete_but_standard entry **  e  )  [static]
 

Destructor.

Parameters:
e to delete

Definition at line 154 of file fors_photometry_impl.c.

References fors_star_delete_but_standard().

void entry_list_print const entry_list *  l,
cpl_msg_severity  level
 

Print list.

Parameters:
l to print
level message level

Definition at line 170 of file fors_photometry_impl.c.

References entry::airmass, entry::exptime, fors_star_print(), entry::frame_number, entry::gain, entry::star, and entry::star_number.

Referenced by fors_photometry().

void fors_photometry_define_parameters cpl_parameterlist *  parameters  ) 
 

Define recipe parameters.

Parameters:
parameters parameter list to fill

Definition at line 194 of file fors_photometry_impl.c.

References fors_photometry_name.

Referenced by fors_photometry_create().

void fors_photometry 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 511 of file fors_photometry_impl.c.

References assure, dfs_get_parameter_bool_const(), dfs_get_parameter_int_const(), entry_list_print(), fors_frameset_extract(), fors_photometry_name, fors_setting_new(), myprintf(), and read_input().

Referenced by fors_photometry_exec().

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

References fors_get_version_binary(), fors_license, fors_photometry_author, fors_photometry_create(), fors_photometry_description, fors_photometry_description_short, fors_photometry_destroy(), fors_photometry_email, fors_photometry_exec(), and fors_photometry_name.

static int fors_photometry_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_photometry.c.

References fors_photometry_define_parameters().

Referenced by cpl_plugin_get_info().

static int fors_photometry_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_photometry.c.

References fors_begin(), fors_end(), fors_photometry(), and fors_photometry_description_short.

Referenced by cpl_plugin_get_info().

static int fors_photometry_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_photometry.c.

Referenced by cpl_plugin_get_info().


Variable Documentation

const char* const fors_photometry_description
 

Initial value:

 
"Input files:\n"
"  DO category:               Type:       Explanation:             Number:\n"
"  ALIGNED_PHOT               FITS table  Photometry                  1+\n"
"  MASTER_SKY_FLAT_IMG        FITS image  Master flat field           1\n"
"\n"
"Output files:\n"
"  DO category:               Data type:  Explanation:\n"
"  CORRECTION_MAP             FITS image  Correction map (magnitude)\n"
"  CORRECTION_FACTOR          FITS image  Correction map (flux)\n"
"  MASTER_FLAT_IMG            FITS image  Corrected master flat field\n"

Definition at line 56 of file fors_photometry_impl.c.

Referenced by cpl_plugin_get_info().


Generated on Wed Sep 10 07:31:55 2008 for FORS Pipeline Reference Manual by  doxygen 1.4.6