facetron.c 12.6 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*
 * facetron.c
 *
 * Profile fitting for coherent nanocrystallography
 *
 * (c) 2006-2010 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>
Thomas White's avatar
Thomas White committed
23
#include <assert.h>
Thomas White's avatar
Tidy up    
Thomas White committed
24
#include <pthread.h>
25

Thomas White's avatar
Thomas White committed
26
#include "utils.h"
27
#include "hdf5-file.h"
Thomas White's avatar
Thomas White committed
28
#include "symmetry.h"
Thomas White's avatar
Thomas White committed
29
30
#include "reflections.h"
#include "stream.h"
31
#include "geometry.h"
32
#include "peaks.h"
Thomas White's avatar
Thomas White committed
33
#include "thread-pool.h"
Thomas White's avatar
Thomas White committed
34
#include "beam-parameters.h"
35
#include "post-refinement.h"
36
37


38
39
/* Maximum number of iterations of NLSq to do for each image per macrocycle. */
#define MAX_CYCLES (100)
40

41

42
43
44
45
static void show_help(const char *s)
{
	printf("Syntax: %s [options]\n\n", s);
	printf(
Thomas White's avatar
Thomas White committed
46
"Post-refinement and profile fitting for coherent nanocrystallography.\n"
47
48
49
"\n"
"  -h, --help                 Display this help message.\n"
"\n"
Thomas White's avatar
Thomas White committed
50
51
"  -i, --input=<filename>     Specify the name of the input 'stream'.\n"
"                              (must be a file, not e.g. stdin)\n"
Thomas White's avatar
Thomas White committed
52
"  -o, --output=<filename>    Output filename.  Default: facetron.hkl.\n"
Thomas White's avatar
Thomas White committed
53
"  -g. --geometry=<file>      Get detector geometry from file.\n"
Thomas White's avatar
Thomas White committed
54
55
56
"  -b, --beam=<file>          Get beam parameters from file (provides initial\n"
"                              values for parameters, and nominal wavelengths\n"
"                              if no per-shot value is found in an HDF5 file.\n"
Thomas White's avatar
Thomas White committed
57
58
59
"  -x, --prefix=<p>           Prefix filenames from input file with <p>.\n"
"      --basename             Remove the directory parts of the filenames.\n"
"      --no-check-prefix      Don't attempt to correct the --prefix.\n"
60
61
62
"  -y, --symmetry=<sym>       Merge according to symmetry <sym>.\n"
"  -n, --iterations=<n>       Run <n> cycles of post-refinement.\n"
"\n"
Thomas White's avatar
Thomas White committed
63
64
65
66
"  -j <n>                     Run <n> analyses in parallel.\n");
}


Thomas White's avatar
Thomas White committed
67
struct refine_args
Thomas White's avatar
Thomas White committed
68
{
Thomas White's avatar
Thomas White committed
69
70
71
72
	const char *sym;
	ReflItemList *obs;
	double *i_full;
	struct image *image;
73
	FILE *graph;
74
	FILE *pgraph;
Thomas White's avatar
Thomas White committed
75
76
77
78
79
80
81
};


static void refine_image(int mytask, void *tasks)
{
	struct refine_args *all_args = tasks;
	struct refine_args *pargs = &all_args[mytask];
82
83
84
85
	struct image *image = pargs->image;
	double nominal_photon_energy = pargs->image->beam->photon_energy;
	struct hdfile *hdfile;
	struct cpeak *spots;
86
	int n, i;
87
	double dev, last_dev;
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

	hdfile = hdfile_open(image->filename);
	if ( hdfile == NULL ) {
		ERROR("Couldn't open '%s'\n", image->filename);
		return;
	} else if ( hdfile_set_image(hdfile, "/data/data0") ) {
		ERROR("Couldn't select path\n");
		hdfile_close(hdfile);
		return;
	}

	if ( hdf5_read(hdfile, pargs->image, 0, nominal_photon_energy) ) {
		ERROR("Couldn't read '%s'\n", image->filename);
		hdfile_close(hdfile);
		return;
	}

105
	spots = find_intersections(image, image->indexed_cell, &n, 0, NULL);
106
107
108
109
	dev = +INFINITY;
	i = 0;
	do {
		last_dev = dev;
110
		dev = pr_iterate(image, pargs->i_full, pargs->sym, &spots, &n);
111
		STATUS("Iteration %2i: mean dev = %5.2f\n", i, dev);
112
		i++;
113
	} while ( (fabs(last_dev - dev) > 1.0) && (i < MAX_CYCLES) );
114
115
	mean_partial_dev(image, spots, n, pargs->sym,
	                 pargs->i_full, pargs->graph);
116
117
118
	if ( pargs->pgraph ) {
		fprintf(pargs->pgraph, "%5i %5.2f\n", mytask, dev);
	}
119
120
121
122

	free(image->data);
	if ( image->flags != NULL ) free(image->flags);
	hdfile_close(hdfile);
123
	free(spots);
124
125
126
127

	/* Muppet proofing */
	image->data = NULL;
	image->flags = NULL;
128
129
130
}


Thomas White's avatar
Thomas White committed
131
struct integrate_args
132
{
Thomas White's avatar
Thomas White committed
133
134
135
136
137
138
139
140
141
142
143
144
145
	const char *sym;
	ReflItemList *obs;
	double *i_full;
	unsigned int *cts;
	pthread_mutex_t *list_lock;
	struct image *image;
};


static void integrate_image(int mytask, void *tasks)
{
	struct integrate_args *all_args = tasks;
	struct integrate_args *pargs = &all_args[mytask];
Thomas White's avatar
Thomas White committed
146
	struct cpeak *spots;
147
148
149
	int j, n;
	struct hdfile *hdfile;
	struct image *image = pargs->image;
Thomas White's avatar
Thomas White committed
150
	double nominal_photon_energy = pargs->image->beam->photon_energy;
151

152
153
154
155
156
157
158
159
160
161
	hdfile = hdfile_open(image->filename);
	if ( hdfile == NULL ) {
		ERROR("Couldn't open '%s'\n", image->filename);
		return;
	} else if ( hdfile_set_image(hdfile, "/data/data0") ) {
		ERROR("Couldn't select path\n");
		hdfile_close(hdfile);
		return;
	}

Thomas White's avatar
Thomas White committed
162
	if ( hdf5_read(hdfile, pargs->image, 0, nominal_photon_energy) ) {
163
164
165
166
167
		ERROR("Couldn't read '%s'\n", image->filename);
		hdfile_close(hdfile);
		return;
	}

Thomas White's avatar
Thomas White committed
168
	/* Figure out which spots should appear in this pattern */
169
	spots = find_intersections(image, image->indexed_cell, &n, 0, NULL);
170
171
172
173
174

	/* For each reflection, estimate the partiality */
	for ( j=0; j<n; j++ ) {

		signed int h, k, l;
175
		signed int ha, ka, la;
176
177
		float i_partial;
		float xc, yc;
Thomas White's avatar
Thomas White committed
178
		float i_full_est;
179
180
181
182
183
184
185

		h = spots[j].h;
		k = spots[j].k;
		l = spots[j].l;

		/* Don't attempt to use spots with very small
		 * partialities, since it won't be accurate. */
Thomas White's avatar
Thomas White committed
186
		if ( spots[j].p < 0.1 ) continue;
187
188
189
190
191

		/* Actual measurement of this reflection from this
		 * pattern? */
		/* FIXME: Coordinates aren't whole numbers */
		if ( integrate_peak(image, spots[j].x, spots[j].y,
Thomas White's avatar
Thomas White committed
192
193
194
		                    &xc, &yc, &i_partial, NULL, NULL, 1, 1) ) {
			continue;
		}
195
		i_partial *= image->osf;
196

Thomas White's avatar
Thomas White committed
197
		i_full_est = i_partial / spots[j].p;
Thomas White's avatar
Thomas White committed
198

199
200
		get_asymm(h, k, l, &ha, &ka, &la, pargs->sym);

201
		pthread_mutex_lock(pargs->list_lock);
202
203
204
205
		integrate_intensity(pargs->i_full, ha, ka, la, i_full_est);
		integrate_count(pargs->cts, ha, ka, la, 1);
		if ( !find_item(pargs->obs, ha, ka, la) ) {
			add_item(pargs->obs, ha, ka, la);
206
207
208
209
210
		}
		pthread_mutex_unlock(pargs->list_lock);

	}

211
212
	free(image->data);
	if ( image->flags != NULL ) free(image->flags);
213
	hdfile_close(hdfile);
Thomas White's avatar
Thomas White committed
214
215
216
217
218
	free(spots);

	/* Muppet proofing */
	image->data = NULL;
	image->flags = NULL;
Thomas White's avatar
Thomas White committed
219
220
221
}


Thomas White's avatar
Thomas White committed
222
223
static void refine_all(struct image *images, int n_total_patterns,
                       struct detector *det, const char *sym,
224
                       ReflItemList *obs, double *i_full, int nthreads,
225
                       FILE *graph, FILE *pgraph)
Thomas White's avatar
Thomas White committed
226
{
Thomas White's avatar
Thomas White committed
227
	struct refine_args *tasks;
Thomas White's avatar
Thomas White committed
228
	int i;
229

Thomas White's avatar
Thomas White committed
230
231
	tasks = malloc(n_total_patterns * sizeof(struct refine_args));
	for ( i=0; i<n_total_patterns; i++ ) {
Thomas White's avatar
Thomas White committed
232

Thomas White's avatar
Thomas White committed
233
234
235
236
		tasks[i].sym = sym;
		tasks[i].obs = obs;
		tasks[i].i_full = i_full;
		tasks[i].image = &images[i];
237
		tasks[i].graph = graph;
238
		tasks[i].pgraph = pgraph;
Thomas White's avatar
Thomas White committed
239
240
241

	}

242
243
	run_thread_range(n_total_patterns, nthreads, "Refining",
	                 refine_image, tasks);
Thomas White's avatar
Thomas White committed
244

Thomas White's avatar
Thomas White committed
245
	free(tasks);
246
247
248
249
250
}


static void estimate_full(struct image *images, int n_total_patterns,
                          struct detector *det, const char *sym,
Thomas White's avatar
Thomas White committed
251
252
                          ReflItemList *obs, double *i_full, unsigned int *cts,
                          int nthreads)
253
254
{
	int i;
Thomas White's avatar
Thomas White committed
255
256
	struct integrate_args *tasks;
	pthread_mutex_t list_lock = PTHREAD_MUTEX_INITIALIZER;
257

258
	clear_items(obs);
259
	memset(i_full, 0, LIST_SIZE*sizeof(double));
260

Thomas White's avatar
Thomas White committed
261
262
263
264
265
266
267
268
269
270
271
272
	tasks = malloc(n_total_patterns * sizeof(struct integrate_args));
	for ( i=0; i<n_total_patterns; i++ ) {

		tasks[i].sym = sym;
		tasks[i].obs = obs;
		tasks[i].i_full = i_full;
		tasks[i].cts = cts;
		tasks[i].list_lock = &list_lock;
		tasks[i].image = &images[i];

	}

273
274
	run_thread_range(n_total_patterns, nthreads, "Integrating",
	                 integrate_image, tasks);
Thomas White's avatar
Thomas White committed
275
276

	free(tasks);
277

278
279
	/* Divide the totals to get the means */
	for ( i=0; i<num_items(obs); i++ ) {
280

281
282
		struct refl_item *it;
		double total;
283

284
285
286
287
		it = get_item(obs, i);
		total = lookup_intensity(i_full, it->h, it->k, it->l);
		total /= lookup_count(cts, it->h, it->k, it->l);
		set_intensity(i_full, it->h, it->k, it->l, total);
288

289
	}
Thomas White's avatar
Thomas White committed
290
}
291

Thomas White's avatar
Thomas White committed
292

Thomas White's avatar
Thomas White committed
293
294
295
296
int main(int argc, char *argv[])
{
	int c;
	char *infile = NULL;
Thomas White's avatar
Thomas White committed
297
	char *outfile = NULL;
Thomas White's avatar
Thomas White committed
298
299
	char *geomfile = NULL;
	char *prefix = NULL;
Thomas White's avatar
Thomas White committed
300
301
	char *sym = NULL;
	FILE *fh;
Thomas White's avatar
Thomas White committed
302
303
304
305
	int nthreads = 1;
	int config_basename = 0;
	int config_checkprefix = 1;
	struct detector *det;
Thomas White's avatar
Thomas White committed
306
	double *i_full;
Thomas White's avatar
Thomas White committed
307
	unsigned int *cts;
Thomas White's avatar
Thomas White committed
308
309
310
	ReflItemList *obs;
	int i;
	int n_total_patterns;
311
312
	struct image *images;
	int n_iter = 10;
Thomas White's avatar
Thomas White committed
313
	struct beam_params *beam = NULL;
Thomas White's avatar
Thomas White committed
314
315
316
317
318

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
		{"input",              1, NULL,               'i'},
Thomas White's avatar
Thomas White committed
319
		{"output",             1, NULL,               'o'},
Thomas White's avatar
Thomas White committed
320
		{"geometry",           1, NULL,               'g'},
Thomas White's avatar
Thomas White committed
321
		{"beam",               1, NULL,               'b'},
Thomas White's avatar
Thomas White committed
322
323
324
		{"prefix",             1, NULL,               'x'},
		{"basename",           0, &config_basename,    1},
		{"no-check-prefix",    0, &config_checkprefix, 0},
325
		{"symmetry",           1, NULL,               'y'},
326
		{"iterations",         1, NULL,               'n'},
Thomas White's avatar
Thomas White committed
327
328
329
330
		{0, 0, NULL, 0}
	};

	/* Short options */
Thomas White's avatar
Thomas White committed
331
	while ((c = getopt_long(argc, argv, "hi:g:x:j:y:o:b:",
332
333
	                        longopts, NULL)) != -1)
	{
Thomas White's avatar
Thomas White committed
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355

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

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

		case 'g' :
			geomfile = strdup(optarg);
			break;

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

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

356
357
358
359
		case 'y' :
			sym = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
360
361
362
363
		case 'o' :
			outfile = strdup(optarg);
			break;

364
365
366
367
		case 'n' :
			n_iter = atoi(optarg);
			break;

Thomas White's avatar
Thomas White committed
368
369
370
371
372
373
374
375
376
		case 'b' :
			beam = get_beam_parameters(optarg);
			if ( beam == NULL ) {
				ERROR("Failed to load beam parameters"
				      " from '%s'\n", optarg);
				return 1;
			}
			break;

Thomas White's avatar
Thomas White committed
377
378
379
380
381
382
383
384
385
		case 0 :
			break;

		default :
			return 1;
		}

	}

Thomas White's avatar
Thomas White committed
386
	/* Sanitise input filename and open */
Thomas White's avatar
Thomas White committed
387
388
389
390
391
392
393
394
395
396
397
398
399
400
	if ( infile == NULL ) {
		infile = strdup("-");
	}
	if ( strcmp(infile, "-") == 0 ) {
		fh = stdin;
	} else {
		fh = fopen(infile, "r");
	}
	if ( fh == NULL ) {
		ERROR("Failed to open input file '%s'\n", infile);
		return 1;
	}
	free(infile);

Thomas White's avatar
Thomas White committed
401
402
403
404
405
406
	/* Sanitise output filename */
	if ( outfile == NULL ) {
		outfile = strdup("facetron.hkl");
	}

	/* Sanitise prefix */
Thomas White's avatar
Thomas White committed
407
408
409
410
411
412
413
414
	if ( prefix == NULL ) {
		prefix = strdup("");
	} else {
		if ( config_checkprefix ) {
			prefix = check_prefix(prefix);
		}
	}

Thomas White's avatar
Thomas White committed
415
416
	if ( sym == NULL ) sym = strdup("1");

Thomas White's avatar
Thomas White committed
417
	/* Get detector geometry */
Thomas White's avatar
Thomas White committed
418
419
420
421
422
423
424
	det = get_detector_geometry(geomfile);
	if ( det == NULL ) {
		ERROR("Failed to read detector geometry from '%s'\n", geomfile);
		return 1;
	}
	free(geomfile);

Thomas White's avatar
Thomas White committed
425
426
427
428
429
	if ( beam == NULL ) {
		ERROR("You must provide a beam parameters file.\n");
		return 1;
	}

Thomas White's avatar
Thomas White committed
430
431
432
433
434
435
436
	/* Prepare for iteration */
	i_full = new_list_intensity();
	obs = new_items();

	n_total_patterns = count_patterns(fh);
	STATUS("There are %i patterns to process\n", n_total_patterns);

437
438
439
440
441
442
443
444
445
446
447
448
	images = malloc(n_total_patterns * sizeof(struct image));
	if ( images == NULL ) {
		ERROR("Couldn't allocate memory for images.\n");
		return 1;
	}

	/* Fill in what we know about the images so far */
	rewind(fh);
	for ( i=0; i<n_total_patterns; i++ ) {

		UnitCell *cell;
		char *filename;
449
		char *fnamereal;
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465

		if ( find_chunk(fh, &cell, &filename) == 1 ) {
			ERROR("Couldn't get all of the filenames and cells"
			      " from the input stream.\n");
			return 1;
		}

		images[i].indexed_cell = cell;

		/* Mangle the filename now */
		if ( config_basename ) {
			char *tmp;
			tmp = strdup(basename(filename));
			free(filename);
			filename = tmp;
		}
466
		fnamereal = malloc(1024);
467
468
469
		snprintf(fnamereal, 1023, "%s%s", prefix, filename);

		images[i].filename = fnamereal;
Thomas White's avatar
Thomas White committed
470
471
		images[i].div = beam->divergence;
		images[i].bw = beam->bandwidth;
472
		images[i].det = det;
Thomas White's avatar
Thomas White committed
473
		images[i].beam = beam;
474
		images[i].osf = 1.0;
475
		images[i].profile_radius = 0.005e9;
476

Thomas White's avatar
Thomas White committed
477
478
479
480
		/* Muppet proofing */
		images[i].data = NULL;
		images[i].flags = NULL;

481
482
483
484
485
486
487
488
		free(filename);

		progress_bar(i, n_total_patterns-1, "Loading pattern data");

	}
	fclose(fh);
	free(prefix);

Thomas White's avatar
Thomas White committed
489
490
	cts = new_list_count();

491
	/* Make initial estimates */
Thomas White's avatar
Thomas White committed
492
	estimate_full(images, n_total_patterns, det, sym, obs, i_full, cts,
493
	              nthreads);
494

Thomas White's avatar
Thomas White committed
495
	/* Iterate */
496
	for ( i=0; i<n_iter; i++ ) {
Thomas White's avatar
Thomas White committed
497

498
499
		FILE *fhg;
		FILE *fhp;
500
501
		char filename[1024];

502
		STATUS("Post refinement iteration %i of %i\n", i+1, n_iter);
Thomas White's avatar
Thomas White committed
503

504
505
506
507
508
509
510
511
512
513
		snprintf(filename, 1023, "p-iteration-%i.dat", i+1);
		fhg = fopen(filename, "w");
		if ( fhg == NULL ) {
			ERROR("Failed to open '%s'\n", filename);
			/* Nothing will be written later */
		}

		snprintf(filename, 1023, "g-iteration-%i.dat", i+1);
		fhp = fopen(filename, "w");
		if ( fhp == NULL ) {
514
515
516
517
			ERROR("Failed to open '%s'\n", filename);
			/* Nothing will be written later */
		}

Thomas White's avatar
Thomas White committed
518
		/* Refine the geometry of all patterns to get the best fit */
519
		refine_all(images, n_total_patterns, det, sym, obs, i_full,
520
		           nthreads, fhg, fhp);
Thomas White's avatar
Thomas White committed
521
522

		/* Re-estimate all the full intensities */
523
		estimate_full(images, n_total_patterns, det, sym, obs, i_full,
Thomas White's avatar
Thomas White committed
524
		              cts, nthreads);
Thomas White's avatar
Thomas White committed
525

526
		fclose(fh);
Thomas White's avatar
Thomas White committed
527
528
529
	}

	/* Output results */
530
	write_reflections(outfile, obs, i_full, NULL, NULL, cts, NULL);
Thomas White's avatar
Thomas White committed
531

Thomas White's avatar
Thomas White committed
532
533
534
	/* Clean up */
	free(i_full);
	delete_items(obs);
Thomas White's avatar
Thomas White committed
535
	free(sym);
Thomas White's avatar
Thomas White committed
536
	free(outfile);
537
538
	free(det->panels);
	free(det);
539
	free(beam);
Thomas White's avatar
Thomas White committed
540
	free(cts);
541
542
543
544
545
	for ( i=0; i<n_total_patterns; i++ ) {
		cell_free(images[i].indexed_cell);
		free(images[i].filename);
	}
	free(images);
546
547
548

	return 0;
}