aboutsummaryrefslogtreecommitdiff
path: root/src/sum_stack.c
blob: 2e5b138ebefff3e0a77997e2e81e829683d8da0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
/*
 * sum_stack.c
 *
 * Sum a stack of images (e.g. for detector calibration)
 *
 * (c) 2006-2011 Thomas White <taw@physics.org>
 *
 * Part of CrystFEL - crystallography with a FEL
 *
 */


#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <getopt.h>
#include <pthread.h>

#include "utils.h"
#include "hdf5-file.h"
#include "filters.h"
#include "peaks.h"
#include "thread-pool.h"


#define INTEGRATION_RADIUS (10)


typedef enum
{
	SUM_THRESHOLD,
	SUM_PEAKS
} SumMethod;

struct sum_args
{
	char *filename;
	int config_cmfilter;
	int config_noisefilter;
	double *sum;
	int w;
	int h;
	SumMethod sum_method;
	double threshold;
	double min_gradient;
	char *element;
};


struct queue_args
{
	FILE *fh;
	int config_cmfilter;
	int config_noisefilter;
	double *sum;
	int w;
	int h;
	SumMethod sum_method;
	double threshold;
	double min_gradient;
	char *element;

	char *use_this_one_instead;
	char *prefix;
	int config_basename;
};


static void show_help(const char *s)
{
	printf("Syntax: %s [options]\n\n", s);
	printf(
"Sum FEL diffraction images.\n"
"\n"
"  -h, --help              Display this help message.\n"
"\n"
"  -i, --input=<filename>  Specify file containing list of images to process.\n"
"                           '-' means stdin, which is the default.\n"
"  -o, --output=<filename> Output filename for summed image in HDF5 format.\n"
"                           Default: summed.h5.\n"
"\n"
"  -p, --intermediate=<P>  Stem of filename for intermediate images.\n"
"                            The filename stem <p> will be postfixed with a\n"
"                            hyphen, the current number of patterns processed\n"
"                            and '.h5'.  Such a pattern will be saved after\n"
"                            every 1000 input patterns.\n"
"                            If this option is not specified, no intermediate\n"
"                            patterns will be saved.\n"
"\n"
"  -s, --sum=<method>      Use this method for summation.  Choose from:\n"
"                           peaks : sum 10px radius circles around peaks.\n"
"                           threshold : sum thresholded images.\n"
"  -t, --threshold=<n>     Set the threshold if summing using the 'threshold'\n"
"                           method.  Default: 400 adu\n"
"      --min-gradient=<n>   Minimum gradient for Zaefferer peak search.\n"
"                            Default: 100,000.\n"
" -e, --image=<element>    Use this image from the HDF5 file.\n"
"                           Example: /data/data0.\n"
"                           Default: The first one found.\n"
"\n"
"      --filter-cm         Perform common-mode noise subtraction on images\n"
"                           before proceeding.\n"
"      --filter-noise      Apply an aggressive noise filter which sets all\n"
"                           pixels in each 3x3 region to zero if any of them\n"
"                           have negative values.\n"
"\n"
"  -j <n>                  Run <n> analyses in parallel.  Default 1.\n"
"  -x, --prefix=<p>        Prefix filenames from input file with 'p'.\n");
}


static void sum_peaks(struct image *image, double *sum, double threshold,
                      double min_gradient)
{
	int i;
	int w = image->width;
	int h = image->height;
	const int lim = INTEGRATION_RADIUS * INTEGRATION_RADIUS;

	search_peaks(image, threshold, min_gradient);

	for ( i=0; i<image_feature_count(image->features); i++ ) {

		struct imagefeature *f = image_get_feature(image->features, i);
		int pfs, pss;
		int fs, ss;

		/* This is not an error. */
		if ( f == NULL ) continue;

		pfs = f->fs;
		pss = f->ss;

		for ( fs=-INTEGRATION_RADIUS; fs<+INTEGRATION_RADIUS; fs++ ) {
		for ( ss=-INTEGRATION_RADIUS; ss<+INTEGRATION_RADIUS; ss++ ) {

			/* Circular mask */
			if ( fs*fs + ss*ss > lim ) continue;

			if ( ((fs+pfs)>=w) || ((fs+pfs)<0) ) continue;
			if ( ((ss+pss)>=h) || ((ss+pss)<0) ) continue;

			float val = image->data[(fs+pfs)+w*(ss+pss)];
			sum[(fs+pfs)+w*(ss+pss)] += val;

		}
		}

	}
}


static void sum_threshold(struct image *image, double *sum, double threshold)
{
	int x, y;

	for ( x=0; x<image->width; x++ ) {
	for ( y=0; y<image->height; y++ ) {
		float val = image->data[x+image->width*y];
		if ( val > threshold ) {
			sum[x+image->width*y] += val;
		}
	}
	}
}


static void add_image(void *args, int cookie)
{
	struct sum_args *pargs = args;
	struct hdfile *hdfile;
	struct image image;

	image.features = NULL;
	image.data = NULL;
	image.flags = NULL;
	image.indexed_cell = NULL;
	image.filename = pargs->filename;
	image.det = NULL;

	STATUS("%3i: Processing '%s'\n", cookie, pargs->filename);

	hdfile = hdfile_open(pargs->filename);
	if ( hdfile == NULL ) return;

	if ( pargs->element != NULL ) {
		int r;
		r = hdfile_set_image(hdfile, pargs->element);
		if ( r ) {
			ERROR("Couldn't select path '%s'\n", pargs->element);
			hdfile_close(hdfile);
			return;
		}
	} else {
		int r;
		r = hdfile_set_first_image(hdfile, "/");
		if ( r ) {
			ERROR("Couldn't select first path\n");
			hdfile_close(hdfile);
			return;
		}

	}

	hdf5_read(hdfile, &image, 1);

	if ( pargs->config_cmfilter ) {
		filter_cm(&image);
	}

	if ( pargs->config_noisefilter ) {
		filter_noise(&image, NULL);
	}

	if ( (pargs->w != image.width) || (pargs->h != image.height) ) {
		ERROR("Wrong image size.\n");
		goto out;
	}

	switch ( pargs->sum_method ) {

	case SUM_THRESHOLD :
		sum_threshold(&image, pargs->sum, pargs->threshold);
		break;

	case SUM_PEAKS :
		sum_peaks(&image, pargs->sum, pargs->threshold,
		          pargs->min_gradient);
		break;

	}

out:
	free(image.data);
	image_feature_list_free(image.features);
	if ( image.flags != NULL ) free(image.flags);
	hdfile_close(hdfile);

	free(pargs->filename);
	free(pargs);
}


static void *get_image(void *qp)
{
	char *line;
	struct sum_args *pargs;
	char *rval;
	struct queue_args *qargs = qp;

	pargs = malloc(sizeof(struct sum_args));

	pargs->w = qargs->w;
	pargs->h = qargs->h;
	pargs->sum_method = qargs->sum_method;
	pargs->threshold = qargs->threshold;
	pargs->min_gradient = qargs->min_gradient;
	pargs->config_cmfilter = qargs->config_cmfilter;
	pargs->config_noisefilter = qargs->config_noisefilter;
	pargs->sum = qargs->sum;

	/* Get the next filename */
	if ( qargs->use_this_one_instead != NULL ) {

		line = qargs->use_this_one_instead;
		qargs->use_this_one_instead = NULL;

	} else {

		line = malloc(1024*sizeof(char));
		rval = fgets(line, 1023, qargs->fh);
		if ( rval == NULL ) {
			free(pargs);
			return NULL;
		}
		chomp(line);

	}

	if ( qargs->config_basename ) {
		char *tmp;
		tmp = safe_basename(line);
		free(line);
		line = tmp;
	}

	pargs->filename = malloc(strlen(qargs->prefix)+strlen(line)+1);
	snprintf(pargs->filename, 1023, "%s%s", qargs->prefix, line);
	free(line);

	return pargs;
}


int main(int argc, char *argv[])
{
	int c;
	char *filename = NULL;
	char *outfile = NULL;
	FILE *fh;
	int n_images = 0;
	int config_cmfilter = 0;
	int config_noisefilter = 0;
	char *prefix = NULL;
	char *sum_str = NULL;
	char *intermediate = NULL;
	double threshold = 400.0;
	float min_gradient = 100000.0;
	SumMethod sum;
	int nthreads = 1;
	struct queue_args qargs;
	int n_done;
	const int chunk_size = 1000;
	struct hdfile *hdfile;
	struct image image;
	char *prepare_line;
	char prepare_filename[1024];
	char *rval;
	int config_basename = 0;
	char *element = NULL;

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
		{"input",              1, NULL,               'i'},
		{"output",             1, NULL,               'o'},
		{"filter-cm",          0, &config_cmfilter,    1},
		{"filter-noise",       0, &config_noisefilter, 1},
		{"prefix",             1, NULL,               'x'},
		{"sum",                1, NULL,               's'},
		{"intermediate",       1, NULL,               'p'},
		{"threshold",          1, NULL,               't'},
		{"min-gradient",       1, NULL,                4},
		{"basename",           0, &config_basename,    1},
		{"image",              1, NULL,               'e'},
		{0, 0, NULL, 0}
	};

	/* Short options */
	while ((c = getopt_long(argc, argv, "hi:x:j:o:s:p:t:",
	                        longopts, NULL)) != -1) {

		switch (c) {
		case 'h' :
			show_help(argv[0]);
			return 0;

		case 'i' :
			filename = strdup(optarg);
			break;

		case 'o' :
			outfile = strdup(optarg);
			break;

		case 'x' :
			prefix = strdup(optarg);
			break;

		case 'j' :
			nthreads = atoi(optarg);
			break;

		case 's' :
			sum_str = strdup(optarg);
			break;

		case 'p' :
			intermediate = strdup(optarg);
			break;

		case 't' :
			threshold = atof(optarg);
			break;

		case 'e' :
			element = strdup(optarg);
			break;

		case 4 :
			min_gradient = strtof(optarg, NULL);
			break;

		case 0 :
			break;

		default :
			return 1;
		}

	}

	if ( filename == NULL ) {
		filename = strdup("-");
	}
	if ( strcmp(filename, "-") == 0 ) {
		fh = stdin;
	} else {
		fh = fopen(filename, "r");
	}
	if ( fh == NULL ) {
		ERROR("Failed to open input file '%s'\n", filename);
		return 1;
	}
	free(filename);

	if ( sum_str == NULL ) {
		STATUS("You didn't specify a summation method, so I'm using"
		       " the 'peaks' method, which gives the best results.\n");
		sum = SUM_PEAKS;
	} else if ( strcmp(sum_str, "peaks") == 0 ) {
		sum = SUM_PEAKS;
	} else if ( strcmp(sum_str, "threshold") == 0) {
		sum = SUM_THRESHOLD;
	} else {
		ERROR("Unrecognised summation method '%s'\n", sum_str);
		return 1;
	}
	free(sum_str);

	if ( prefix == NULL ) {
		prefix = strdup("");
	}

	if ( outfile == NULL ) {
		outfile = strdup("summed.h5");
	}

	if ( nthreads == 0  ) {
		ERROR("Invalid number of threads.\n");
		return 1;
	}

	/* Get first filename and use it to set up the summed array */
	prepare_line = malloc(1024*sizeof(char));
	rval = fgets(prepare_line, 1023, fh);
	if ( rval == NULL ) {
		ERROR("Failed to get filename to prepare indexing.\n");
		return 1;
	}
	chomp(prepare_line);
	if ( config_basename ) {
		char *tmp;
		tmp = safe_basename(prepare_line);
		free(prepare_line);
		prepare_line = tmp;
	}
	snprintf(prepare_filename, 1023, "%s%s", prefix, prepare_line);
	qargs.use_this_one_instead = prepare_line;

	hdfile = hdfile_open(prepare_filename);
	if ( hdfile == NULL ) {
		ERROR("Couldn't open '%s'\n", prepare_filename);
		return 1;
	}

	if ( hdf5_read(hdfile, &image, 0) ) {
		ERROR("Couldn't read '%s'\n", prepare_filename);
		return 1;
	}

	hdfile_close(hdfile);
	qargs.w = image.width;
	qargs.h = image.height;

	qargs.sum_method = sum;
	qargs.threshold = threshold;
	qargs.config_basename = config_basename;
	qargs.config_cmfilter = config_cmfilter;
	qargs.config_noisefilter = config_noisefilter;
	qargs.sum = calloc(qargs.w*qargs.h, sizeof(double));
	qargs.prefix = prefix;
	qargs.fh = fh;
	qargs.element = element;

	do {

		n_done = run_threads(nthreads, add_image, get_image,
		                     (void *)&qargs, NULL, chunk_size, 0, 0, 0);

		n_images += n_done;

		/* Write intermediate sum if requested */
		if ( (intermediate != NULL) && (n_done == chunk_size) ) {
			char outfile[1024];
			snprintf(outfile, 1023, "%s-%i.h5",
			         intermediate, n_images);
			hdf5_write(outfile, qargs.sum, qargs.w, qargs.h,
			           H5T_NATIVE_DOUBLE);
		}

	} while ( n_done == chunk_size );

	/* Write the final output */
	hdf5_write(outfile, qargs.sum, qargs.w, qargs.h, H5T_NATIVE_DOUBLE);

	free(qargs.sum);
	free(prefix);
	free(outfile);
	if ( intermediate != NULL ) free(intermediate);
	fclose(fh);

	STATUS("There were %i images.\n", n_images);

	return 0;
}