38 #include "vircam_utils.h"
39 #include "vircam_mask.h"
40 #include "vircam_pfits.h"
41 #include "vircam_dfs.h"
42 #include "vircam_stats.h"
43 #include "vircam_paf.h"
47 static int vircam_dark_current_create(cpl_plugin *) ;
48 static int vircam_dark_current_exec(cpl_plugin *) ;
49 static int vircam_dark_current_destroy(cpl_plugin *) ;
50 static int vircam_dark_current(cpl_parameterlist *, cpl_frameset *) ;
51 static int vircam_dark_current_save(cpl_frameset *filelist,
52 cpl_parameterlist *parlist);
53 static int vircam_dark_current_lastbit(
int jext, cpl_frameset *framelist,
54 cpl_parameterlist *parlist);
55 static void vircam_dark_current_init(
void);
56 static void vircam_dark_current_tidy(
void);
69 float mean_dark_current;
70 } vircam_dark_current_config;
74 cpl_frameset *darklist;
75 vir_mask *master_mask;
84 cpl_propertylist *phupaf;
87 static cpl_frame *product_frame = NULL;
91 static char vircam_dark_current_description[] =
92 "vircam_dark_current -- VIRCAM recipe for measuring dark current.\n"
93 "A list of dark frames is given. A robust estimate of the dark current\n"
94 "is calculated by fitting a median slope to the dark value vs exposure time\n"
95 "for each pixel. The output is to a dark current map which shows the dark\n"
96 "current in counts per second for each input pixel.\n\n"
97 "The program requires the following files in the SOF:\n\n"
99 " -----------------------------------------------------------------------\n"
100 " %-21s A list of raw dark images with various exposure times\n"
101 " %-21s Optional master bad pixel map or\n"
102 " %-21s Optional master confidence map\n"
179 int cpl_plugin_get_info(cpl_pluginlist *list) {
180 cpl_recipe *recipe = cpl_calloc(1,
sizeof(*recipe));
181 cpl_plugin *plugin = &recipe->interface;
182 char alldesc[SZ_ALLDESC];
183 (void)snprintf(alldesc,SZ_ALLDESC,vircam_dark_current_description,
184 VIRCAM_DARKCUR_RAW,VIRCAM_CAL_BPM,VIRCAM_CAL_CONF);
186 cpl_plugin_init(plugin,
188 VIRCAM_BINARY_VERSION,
189 CPL_PLUGIN_TYPE_RECIPE,
190 "vircam_dark_current",
191 "VIRCAM recipe to determine detector dark current",
196 vircam_dark_current_create,
197 vircam_dark_current_exec,
198 vircam_dark_current_destroy);
200 cpl_pluginlist_append(list,plugin);
216 static int vircam_dark_current_create(cpl_plugin *plugin) {
222 if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE)
223 recipe = (cpl_recipe *)plugin;
229 recipe->parameters = cpl_parameterlist_new();
233 p = cpl_parameter_new_value(
"vircam.vircam_dark_current.thresh",
235 "Rejection threshold in sigma above background",
"vircam.vircam_dark_current",5.0);
236 cpl_parameter_set_alias(p,CPL_PARAMETER_MODE_CLI,
"thresh");
237 cpl_parameterlist_append(recipe->parameters,p);
241 p = cpl_parameter_new_range(
"vircam.vircam_dark_current.extenum",
243 "Extension number to be done, 0 == all",
244 "vircam.vircam_dark_current",
246 cpl_parameter_set_alias(p,CPL_PARAMETER_MODE_CLI,
"ext");
247 cpl_parameterlist_append(recipe->parameters,p);
263 static int vircam_dark_current_destroy(cpl_plugin *plugin) {
268 if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE)
269 recipe = (cpl_recipe *)plugin;
273 cpl_parameterlist_delete(recipe->parameters);
286 static int vircam_dark_current_exec(cpl_plugin *plugin) {
291 if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE)
292 recipe = (cpl_recipe *)plugin;
296 return(vircam_dark_current(recipe->parameters,recipe->frames));
308 static int vircam_dark_current(cpl_parameterlist *parlist,
309 cpl_frameset *framelist) {
310 int jst,jfn,i,j,nx,ny,n,retval,live;
313 double intercept,slope,sig;
314 const char *fctid =
"vircam_dark_current";
318 cpl_frame *cur_frame;
319 cpl_propertylist *plist;
324 if (framelist == NULL || cpl_frameset_get_size(framelist) <= 0) {
325 cpl_msg_error(fctid,
"Input framelist NULL or has no input data");
332 cpl_msg_error(fctid,
"Input frameset is missing files. Check SOF");
338 vircam_dark_current_init();
342 p = cpl_parameterlist_find(parlist,
"vircam.vircam_dark_current.thresh");
343 vircam_dark_current_config.thresh = (float)cpl_parameter_get_double(p);
344 p = cpl_parameterlist_find(parlist,
"vircam.vircam_dark_current.extenum");
345 vircam_dark_current_config.extenum = cpl_parameter_get_int(p);
350 cpl_msg_error(fctid,
"Cannot identify RAW and CALIB frames");
358 cpl_msg_error(fctid,
"Cannot labelise the input frameset");
359 vircam_dark_current_tidy();
363 VIRCAM_DARKCUR_RAW)) == NULL) {
364 cpl_msg_error(fctid,
"Cannot find dark frames in input frameset");
365 vircam_dark_current_tidy();
368 ps.nframes = cpl_frameset_get_size(ps.darklist);
369 if (ps.nframes < 2) {
370 cpl_msg_error(fctid,
"Dark frameset doesn't have enough frames");
371 vircam_dark_current_tidy();
382 ps.data = cpl_malloc(ps.nframes*
sizeof(
float *));
383 ps.subset = cpl_malloc(ps.nframes*
sizeof(
double));
384 ps.exps = cpl_malloc(ps.nframes*
sizeof(
double));
388 for (i = 0; i < ps.nframes; i++) {
389 cur_frame = cpl_frameset_get_frame(ps.darklist,i);
390 plist = cpl_propertylist_load(cpl_frame_get_filename(cur_frame),0);
392 cpl_msg_error(fctid,
"Unable to get exposure time for %s",
393 cpl_frame_get_filename(cur_frame));
396 ps.exps[i] = (double)val;
397 cpl_propertylist_delete(plist);
405 (
const cpl_frame *)cpl_frameset_get_frame(ps.darklist,0),
407 if (jst == -1 || jfn == -1) {
408 cpl_msg_error(fctid,
"Unable to continue");
409 vircam_dark_current_tidy();
415 ps.good = cpl_malloc(ps.nframes*
sizeof(vir_fits *));
419 for (j = jst; j <= jfn; j++) {
420 isfirst = (j == jst);
422 vircam_dark_current_config.mean_dark_current = 0.0;
428 if (ps.allfits == NULL) {
430 "Extension %" CPL_SIZE_FORMAT
" darks wouldn't load",
433 retval = vircam_dark_current_lastbit(j,framelist,parlist);
442 for (i = 0; i < ps.nframes; i++) {
446 cpl_msg_info(fctid,
"Detector flagged dead %s",
450 ps.good[ps.ngood] = ff;
459 cpl_msg_warning(fctid,
460 "Need at least 2 good images -- %" CPL_SIZE_FORMAT
" found",
461 (cpl_size)(ps.ngood));
463 retval = vircam_dark_current_lastbit(j,framelist,parlist);
464 freefitslist(ps.allfits,ps.nframes);
465 freeimage(ps.outimage);
473 for (i = 0; i < ps.ngood; i++)
481 if (retval == VIR_FATAL) {
483 "Unable to load mask image %s[%" CPL_SIZE_FORMAT
"]",
485 cpl_msg_info(fctid,
"Forcing all pixels to be good from now on");
492 ps.outimage = cpl_image_new((cpl_size)nx,(cpl_size)ny,CPL_TYPE_FLOAT);
493 outdata = cpl_image_get_data(ps.outimage);
498 "Doing dark current fits for extension %" CPL_SIZE_FORMAT,
500 npts = (long)(nx*ny);
501 for (n = 0; n < npts; n++) {
505 for (i = 0; i < ps.ngood; i++)
506 ps.subset[i] = (
double)(ps.data[i][n]);
513 outdata[n] = (float)slope;
518 vircam_dark_current_config.mean_dark_current =
523 (void)vircam_dark_current_lastbit(j,framelist,parlist);
527 freeimage(ps.outimage);
529 freefitslist(ps.allfits,ps.nframes);
534 vircam_dark_current_tidy();
548 static int vircam_dark_current_save(cpl_frameset *framelist,
549 cpl_parameterlist *parlist) {
550 cpl_propertylist *plist,*p;
551 const char *fctid =
"vircam_dark_current_save";
552 const char *outfile =
"darkcurrent.fits";
553 const char *outpaf =
"darkcurrent";
554 const char *recipeid =
"vircam_dark_current";
560 darkcur_med = vircam_dark_current_config.mean_dark_current;
565 product_frame = cpl_frame_new();
566 cpl_frame_set_filename(product_frame,outfile);
567 cpl_frame_set_tag(product_frame,VIRCAM_PRO_DARKCUR);
568 cpl_frame_set_type(product_frame,CPL_FRAME_TYPE_IMAGE);
569 cpl_frame_set_group(product_frame,CPL_FRAME_GROUP_PRODUCT);
570 cpl_frame_set_level(product_frame,CPL_FRAME_LEVEL_FINAL);
575 ps.phupaf = vircam_paf_phu_items(plist);
577 parlist,(
char *)recipeid,
579 vircam_paf_append(ps.phupaf,plist,
"ESO PRO CATG");
583 if (cpl_image_save(NULL,outfile,CPL_TYPE_UCHAR,plist,
584 CPL_IO_DEFAULT) != CPL_ERROR_NONE) {
585 cpl_msg_error(fctid,
"Cannot save product PHU");
586 cpl_propertylist_delete(plist);
589 cpl_frameset_insert(framelist,product_frame);
596 parlist,(
char *)recipeid,
601 cpl_propertylist_update_float(plist,
"ESO QC DARKCURRENT",darkcur_med);
602 cpl_propertylist_set_comment(plist,
"ESO QC DARKCURRENT",
603 "[ADU/s] Median dark current");
609 if (cpl_image_save(ps.outimage,outfile,CPL_TYPE_FLOAT,plist,
610 CPL_IO_EXTEND) != CPL_ERROR_NONE) {
611 cpl_msg_error(fctid,
"Cannot save product image extension");
612 cpl_propertylist_delete(plist);
618 p = vircam_paf_req_items(plist);
620 if (vircam_paf_print((
char *)outpaf,
"VIRCAM/vircam_dark_current",
"QC file",
622 cpl_msg_warning(fctid,
"Unable to write PAF");
623 cpl_propertylist_delete(p);
640 static int vircam_dark_current_lastbit(
int jext, cpl_frameset *framelist,
641 cpl_parameterlist *parlist) {
643 const char *fctid=
"vircam_dark_current_lastbit";
652 cpl_msg_info(fctid,
"Saving products for extension %" CPL_SIZE_FORMAT,
654 retval = vircam_dark_current_save(framelist,parlist);
656 vircam_dark_current_tidy();
669 static void vircam_dark_current_init(
void) {
672 ps.master_mask = NULL;
689 static void vircam_dark_current_tidy(
void) {
691 freespace(ps.labels);
692 freeframeset(ps.darklist);
693 freemask(ps.master_mask);
695 freespace(ps.subset);
697 freeimage(ps.outimage);
698 freefitslist(ps.allfits,ps.nframes);
701 freepropertylist(ps.phupaf);
const char * vircam_get_license(void)
void vircam_mask_force(vir_mask *m, int nx, int ny)
int vircam_compare_tags(const cpl_frame *frame1, const cpl_frame *frame2)
void vircam_merge_propertylists(cpl_propertylist *p1, cpl_propertylist *p2)
vir_fits ** vircam_fits_load_list(cpl_frameset *f, cpl_type type, int exten)
void vircam_mask_clear(vir_mask *m)
cpl_image * vircam_dummy_image(vir_fits *model)
int vircam_pfits_get_exptime(const cpl_propertylist *plist, float *exptime)
Get the value of exposure time.
int vircam_mask_load(vir_mask *m, int nexten, int nx, int ny)
char * vircam_fits_get_fullname(vir_fits *p)
unsigned char * vircam_mask_get_data(vir_mask *m)
void vircam_linfit(int npts, double *xdata, double *ydata, double *intercept, double *slope, double *sig)
cpl_image * vircam_fits_get_image(vir_fits *p)
cpl_frameset * vircam_frameset_subgroup(cpl_frameset *frameset, cpl_size *labels, cpl_size nlab, const char *tag)
void vircam_dfs_set_product_exten_header(cpl_propertylist *plist, cpl_frame *frame, cpl_frameset *frameset, cpl_parameterlist *parlist, char *recipeid, const char *dict, cpl_frame *inherit)
void vircam_dfs_set_product_primary_header(cpl_propertylist *plist, cpl_frame *frame, cpl_frameset *frameset, cpl_parameterlist *parlist, char *recipeid, const char *dict, cpl_frame *inherit, int synch)
int vircam_fits_set_error(vir_fits *p, int status)
float vircam_med(float *data, unsigned char *bpm, long npts)
void vircam_dummy_property(cpl_propertylist *p)
cpl_propertylist * vircam_fits_get_phu(vir_fits *p)
cpl_propertylist * vircam_fits_get_ehu(vir_fits *p)
int vircam_frameset_fexists(cpl_frameset *frameset)
const char * vircam_mask_get_filename(vir_mask *m)
vir_mask * vircam_mask_define(cpl_frameset *framelist, cpl_size *labels, cpl_size nlab)
int vircam_pfits_get_detlive(const cpl_propertylist *plist, int *detlive)
Get the value of DET_LIVE.
void vircam_exten_range(int inexten, const cpl_frame *fr, int *out1, int *out2)
int vircam_dfs_set_groups(cpl_frameset *set)