facetron.c 10.4 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
24
25
#include <pthread.h>
#include <sys/time.h>
#include <assert.h>
26

Thomas White's avatar
Thomas White committed
27
#include "utils.h"
28
#include "hdf5-file.h"
Thomas White's avatar
Thomas White committed
29
#include "symmetry.h"
Thomas White's avatar
Thomas White committed
30
31
#include "reflections.h"
#include "stream.h"
32
#include "geometry.h"
Thomas White's avatar
Thomas White committed
33
34
35
36
37
38


#define MAX_THREADS (256)

struct process_args
{
39
	struct image *image;
Thomas White's avatar
Thomas White committed
40
41
42
43
44
45
46

	/* Thread control */
	pthread_mutex_t control_mutex;  /* Protects the scary stuff below */
	int start;
	int finish;
	int done;

47
	/* Analysis parameters */
Thomas White's avatar
Thomas White committed
48
	const char *sym;
49
50
	ReflItemList *obs;
	double *i_full;
Thomas White's avatar
Thomas White committed
51
};
52
53
54
55
56
57


static void show_help(const char *s)
{
	printf("Syntax: %s [options]\n\n", s);
	printf(
Thomas White's avatar
Thomas White committed
58
"Post-refinement and profile fitting for coherent nanocrystallography.\n"
59
60
61
"\n"
"  -h, --help                 Display this help message.\n"
"\n"
Thomas White's avatar
Thomas White committed
62
63
"  -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
64
"  -o, --output=<filename>    Output filename.  Default: facetron.hkl.\n"
Thomas White's avatar
Thomas White committed
65
66
67
68
"  -g. --geometry=<file>      Get detector geometry from file.\n"
"  -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"
69
70
71
"  -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
72
73
74
75
"  -j <n>                     Run <n> analyses in parallel.\n");
}


76
static void refine_image(struct image *image, ReflItemList *obs, double *i_full)
Thomas White's avatar
Thomas White committed
77
{
78
79
80
81
82
83
84
	//struct hdfile *hdfile;

	image->features = NULL;
	image->data = NULL;
	image->flags = NULL;
	image->hits = NULL;
	image->n_hits = 0;
Thomas White's avatar
Thomas White committed
85
86

	/* View head-on (unit cell is tilted) */
87
88
89
90
	image->orientation.w = 1.0;
	image->orientation.x = 0.0;
	image->orientation.y = 0.0;
	image->orientation.z = 0.0;
Thomas White's avatar
Thomas White committed
91

Thomas White's avatar
Thomas White committed
92
93
94
95
96
97
98
99
	//hdfile = hdfile_open(pargs->filename);
	//if ( hdfile == NULL ) {
	//	return;
	//} else if ( hdfile_set_first_image(hdfile, "/") ) {
	//	ERROR("Couldn't select path\n");
	//	hdfile_close(hdfile);
	//	return;
	//}
Thomas White's avatar
Thomas White committed
100

Thomas White's avatar
Thomas White committed
101
	//hdf5_read(hdfile, &image, 1);
Thomas White's avatar
Thomas White committed
102

103
104
	free(image->data);
	if ( image->flags != NULL ) free(image->flags);
Thomas White's avatar
Thomas White committed
105
	//hdfile_close(hdfile);
Thomas White's avatar
Thomas White committed
106
107
108
109
110
111
112
113
114
115
116
117
}


static void *worker_thread(void *pargsv)
{
	struct process_args *pargs = pargsv;
	int finish;

	do {

		int wakeup;

118
		refine_image(pargs->image, pargs->obs, pargs->i_full);
Thomas White's avatar
Thomas White committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

		pthread_mutex_lock(&pargs->control_mutex);
		pargs->done = 1;
		pthread_mutex_unlock(&pargs->control_mutex);

		/* Go to sleep until told to exit or process next image */
		do {

			pthread_mutex_lock(&pargs->control_mutex);
			/* Either of these can result in the thread waking up */
			wakeup = pargs->start || pargs->finish;
			finish = pargs->finish;
			pthread_mutex_unlock(&pargs->control_mutex);
			usleep(20000);

		} while ( !wakeup );

	} while ( !pargs->finish );

	return NULL;
139
140
141
}


142
143
144
static void refine_all(struct image *images, int n_total_patterns,
                       struct detector *det, const char *sym,
                       ReflItemList *obs, double *i_full, int nthreads)
Thomas White's avatar
Thomas White committed
145
{
Thomas White's avatar
Thomas White committed
146
147
148
149
	pthread_t workers[MAX_THREADS];
	struct process_args *worker_args[MAX_THREADS];
	int worker_active[MAX_THREADS];
	int i;
Thomas White's avatar
Thomas White committed
150
	int n_done = 0;
151
	int n_started = 0;
152

153
	/* Initialise worker arguments with the unchanging data */
Thomas White's avatar
Thomas White committed
154
	for ( i=0; i<nthreads; i++ ) {
Thomas White's avatar
Thomas White committed
155

Thomas White's avatar
Thomas White committed
156
157
158
159
		worker_args[i] = malloc(sizeof(struct process_args));
		worker_active[i] = 0;
		pthread_mutex_init(&worker_args[i]->control_mutex, NULL);
		worker_args[i]->sym = sym;
160

Thomas White's avatar
Thomas White committed
161
	}
162

Thomas White's avatar
Thomas White committed
163
164
	/* Start threads off */
	for ( i=0; i<nthreads; i++ ) {
Thomas White's avatar
Thomas White committed
165

Thomas White's avatar
Thomas White committed
166
167
		struct process_args *pargs;
		int r;
168

Thomas White's avatar
Thomas White committed
169
		pargs = worker_args[i];
170
		pargs->image = &images[n_started++];
Thomas White's avatar
Thomas White committed
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

		pthread_mutex_lock(&pargs->control_mutex);
		pargs->done = 0;
		pargs->start = 1;
		pargs->finish = 0;
		pthread_mutex_unlock(&pargs->control_mutex);

		worker_active[i] = 1;
		r = pthread_create(&workers[i], NULL, worker_thread, pargs);
		if ( r != 0 ) {
			worker_active[i] = 0;
			ERROR("Couldn't start thread %i\n", i);
		}

	}

	/* Keep threads busy until the end of the data */
	do {

		int i;

		for ( i=0; i<nthreads; i++ ) {

			struct process_args *pargs;
			int done;

			/* Spend time working, not managing threads */
			usleep(100000);

			/* Are we using this thread record at all? */
			if ( !worker_active[i] ) continue;

			/* Has the thread finished yet? */
			pargs = worker_args[i];
			pthread_mutex_lock(&pargs->control_mutex);
			done = pargs->done;
			pthread_mutex_unlock(&pargs->control_mutex);
			if ( !done ) continue;

210
211
212
			/* Reset "done" flag */
			pargs->done = 0;

Thomas White's avatar
Thomas White committed
213
214
215
			n_done++;
			progress_bar(n_done, n_total_patterns, "Refining");

216
217
			/* If there are no more patterns, "done" will remain
			 * zero, so the last pattern will not be re-counted. */
218
			if ( n_started == n_total_patterns ) break;
Thomas White's avatar
Thomas White committed
219

220
221
			/* Start work on the next pattern */
			pargs->image = &images[n_started++];
Thomas White's avatar
Thomas White committed
222
223
224
225
226
227
			pthread_mutex_lock(&pargs->control_mutex);
			pargs->start = 1;
			pthread_mutex_unlock(&pargs->control_mutex);

		}

228
	} while ( n_started < n_total_patterns );
Thomas White's avatar
Thomas White committed
229
230
231
232

	/* Join threads */
	for ( i=0; i<nthreads; i++ ) {

233
		if ( !worker_active[i] ) continue;
Thomas White's avatar
Thomas White committed
234
235
236
237
238
239
240
241
242
243

		/* Tell the thread to exit */
		struct process_args *pargs = worker_args[i];
		pthread_mutex_lock(&pargs->control_mutex);
		pargs->finish = 1;
		pthread_mutex_unlock(&pargs->control_mutex);

		/* Wait for it to join */
		pthread_join(workers[i], NULL);

244
245
246
247
		if ( pargs->done ) {
			n_done++;
			progress_bar(n_done, n_total_patterns, "Refining");
		} /* else this thread was not busy */
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

	}
}


static double partiality(struct image *image, double x, double y)
{
	return 1.0;
}


static void estimate_full(struct image *images, int n_total_patterns,
                          struct detector *det, const char *sym,
                          ReflItemList *obs, double *i_full)
{
	int i;

	for ( i=0; i<n_total_patterns; i++ ) {

		struct reflhit *spots;
		struct image *image = &images[i];
		int j, n;

		/* Get the "spots" appearing in this pattern */
		spots = find_intersections(image, image->indexed_cell,
		                           image->div, image->bw, &n, 0);

		/* For each spot, estimate the partiality */
		for ( j=0; j<n; j++ ) {
			double p = partiality(image, spots[j].x, spots[j].y);
Thomas White's avatar
Thomas White committed
278
		}
279

280
281
		progress_bar(i, n_total_patterns-1, "Integrating");

282
	}
Thomas White's avatar
Thomas White committed
283
}
284

Thomas White's avatar
Thomas White committed
285

Thomas White's avatar
Thomas White committed
286
287
288
289
int main(int argc, char *argv[])
{
	int c;
	char *infile = NULL;
Thomas White's avatar
Thomas White committed
290
	char *outfile = NULL;
Thomas White's avatar
Thomas White committed
291
292
	char *geomfile = NULL;
	char *prefix = NULL;
Thomas White's avatar
Thomas White committed
293
294
	char *sym = NULL;
	FILE *fh;
Thomas White's avatar
Thomas White committed
295
296
297
298
	int nthreads = 1;
	int config_basename = 0;
	int config_checkprefix = 1;
	struct detector *det;
Thomas White's avatar
Thomas White committed
299
300
301
302
	double *i_full;
	ReflItemList *obs;
	int i;
	int n_total_patterns;
303
304
	struct image *images;
	int n_iter = 10;
Thomas White's avatar
Thomas White committed
305
306
307
308
309

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
		{"input",              1, NULL,               'i'},
Thomas White's avatar
Thomas White committed
310
		{"output",             1, NULL,               'o'},
Thomas White's avatar
Thomas White committed
311
312
313
314
		{"geometry",           1, NULL,               'g'},
		{"prefix",             1, NULL,               'x'},
		{"basename",           0, &config_basename,    1},
		{"no-check-prefix",    0, &config_checkprefix, 0},
315
		{"symmetry",           1, NULL,               'y'},
316
		{"iterations",         1, NULL,               'n'},
Thomas White's avatar
Thomas White committed
317
318
319
320
		{0, 0, NULL, 0}
	};

	/* Short options */
Thomas White's avatar
Thomas White committed
321
	while ((c = getopt_long(argc, argv, "hi:g:x:j:y:o:",
322
323
	                        longopts, NULL)) != -1)
	{
Thomas White's avatar
Thomas White committed
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345

		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;

346
347
348
349
		case 'y' :
			sym = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
350
351
352
353
		case 'o' :
			outfile = strdup(optarg);
			break;

354
355
356
357
		case 'n' :
			n_iter = atoi(optarg);
			break;

Thomas White's avatar
Thomas White committed
358
359
360
361
362
363
364
365
366
		case 0 :
			break;

		default :
			return 1;
		}

	}

Thomas White's avatar
Thomas White committed
367
	/* Sanitise input filename and open */
Thomas White's avatar
Thomas White committed
368
369
370
371
372
373
374
375
376
377
378
379
380
381
	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
382
383
384
385
386
387
	/* Sanitise output filename */
	if ( outfile == NULL ) {
		outfile = strdup("facetron.hkl");
	}

	/* Sanitise prefix */
Thomas White's avatar
Thomas White committed
388
389
390
391
392
393
394
395
	if ( prefix == NULL ) {
		prefix = strdup("");
	} else {
		if ( config_checkprefix ) {
			prefix = check_prefix(prefix);
		}
	}

Thomas White's avatar
Thomas White committed
396
	/* Get detector geometry */
Thomas White's avatar
Thomas White committed
397
398
399
400
401
402
403
	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
404
405
406
407
408
409
410
	/* 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);

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
	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;
		char fnamereal[1024];

		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;
		}
		snprintf(fnamereal, 1023, "%s%s", prefix, filename);

		images[i].filename = fnamereal;
		images[i].div = 0.5e-3;
		images[i].bw = 0.001;

		free(filename);

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

	}
	fclose(fh);
	free(prefix);

	/* Make initial estimates */
	estimate_full(images, n_total_patterns, det, sym, obs, i_full);

Thomas White's avatar
Thomas White committed
457
	/* Iterate */
458
	for ( i=0; i<n_iter; i++ ) {
Thomas White's avatar
Thomas White committed
459

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

		/* Refine the geometry of all patterns to get the best fit */
463
464
		refine_all(images, n_total_patterns, det, sym, obs, i_full,
		           nthreads);
Thomas White's avatar
Thomas White committed
465
466

		/* Re-estimate all the full intensities */
467
		estimate_full(images, n_total_patterns, det, sym, obs, i_full);
Thomas White's avatar
Thomas White committed
468
469
470
471
472

	}

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

Thomas White's avatar
Thomas White committed
474
475
476
	/* Clean up */
	free(i_full);
	delete_items(obs);
Thomas White's avatar
Thomas White committed
477
	free(sym);
Thomas White's avatar
Thomas White committed
478
	free(outfile);
479
480
481

	return 0;
}