pattern_sim.c 15.7 KB
Newer Older
1
/*
Thomas White's avatar
Thomas White committed
2
3
4
 * pattern_sim.c
 *
 * Simulate diffraction patterns from small crystals
5
 *
Thomas White's avatar
Thomas White committed
6
 * (c) 2006-2010 Thomas White <taw@physics.org>
7
 *
Thomas White's avatar
Thomas White committed
8
 * Part of CrystFEL - crystallography with a FEL
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 */


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

#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
Thomas White's avatar
Thomas White committed
22
#include <getopt.h>
23

24
#include "image.h"
Thomas White's avatar
Thomas White committed
25
#include "diffraction.h"
26
#include "diffraction-gpu.h"
27
#include "cell.h"
28
29
#include "utils.h"
#include "hdf5-file.h"
Thomas White's avatar
Thomas White committed
30
#include "detector.h"
31
#include "peaks.h"
Thomas White's avatar
Thomas White committed
32
#include "sfac.h"
33
#include "reflections.h"
34
#include "beam-parameters.h"
35
36


Thomas White's avatar
Thomas White committed
37
static void show_help(const char *s)
38
{
39
	printf("Syntax: %s [options]\n\n", s);
Thomas White's avatar
Thomas White committed
40
	printf(
Thomas White's avatar
Thomas White committed
41
"Simulate diffraction patterns from small crystals probed with femtosecond\n"
Thomas White's avatar
Thomas White committed
42
43
"pulses of X-rays from a free electron laser.\n"
"\n"
44
" -h, --help                Display this help message.\n"
Thomas White's avatar
Thomas White committed
45
"\n"
46
47
48
" -p, --pdb=<file>          PDB file from which to get the unit cell.\n"
"                            (The actual Bragg intensities come from the\n"
"                            intensities file)\n"
49
"     --simulation-details  Show technical details of the simulation.\n"
50
"     --gpu                 Use the GPU to speed up the calculation.\n"
Thomas White's avatar
Thomas White committed
51
52
"     --gpu-dev=<n>         Use GPU device <n>.  Omit this option to see the\n"
"                            available devices.\n"
53
54
" -g, --geometry=<file>     Get detector geometry from file.\n"
" -b, --beam=<file>         Get beam parameters from file.\n"
55
56
57
58
"\n"
"     --near-bragg          Output h,k,l,I near Bragg conditions.\n"
" -n, --number=<N>          Generate N images.  Default 1.\n"
"     --no-images           Do not output any HDF5 files.\n"
59
60
61
62
63
64
" -o, --output=<filename>   Output HDF5 filename.  Default: sim.h5.\n"
"                            If you choose to simulate more than one pattern,\n"
"                            the filename given will be postfixed with a\n"
"                            hyphen, the image number and '.h5'.  In this\n"
"                            case, the default value is 'sim', such that the\n"
"                            files produced are sim-1.h5, sim-2.h5 and so on.\n"
Thomas White's avatar
Thomas White committed
65
" -r, --random-orientation  Use a randomly generated orientation\n"
66
"                            (a new orientation will be used for each image).\n"
67
68
"     --powder=<file>       Write a summed pattern of all images simulated by\n"
"                            this invocation as the given filename.\n"
69
" -i, --intensities=<file>  Specify file containing reflection intensities\n"
Thomas White's avatar
Thomas White committed
70
"                            (and phases) to use.\n"
Thomas White's avatar
Thomas White committed
71
" -t, --gradients=<method>  Use <method> for the calculation of shape\n"
72
73
"                            transform intensities.  Choose from:\n"
"                             mosaic      : Take the intensity of the nearest\n"
Thomas White's avatar
Thomas White committed
74
75
76
"                                           Bragg position.  This is the\n"
"                                           fastest method and the only one\n"
"                                           supported on the GPU.\n"
77
78
"                             interpolate : Interpolate trilinearly between\n"
"                                           six adjacent Bragg intensities.\n"
Thomas White's avatar
Thomas White committed
79
80
"                                           This method has intermediate\n"
"                                           accuracy.\n"
81
"                             phased      : As 'interpolate', but take phase\n"
Thomas White's avatar
Thomas White committed
82
83
84
"                                           values into account.  This is the\n"
"                                           most accurate method, but the\n"
"                                           slowest.\n"
85
86
87
"     --really-random       Use really random numbers for the orientation and\n"
"                            crystal size.  By default, the same sequence\n"
"                            will be used for each new run.\n"
88
89
90
91
92
"     --min-size=<s>        Generate random crystal sizes using <s> as the\n"
"                            minimum crystal size in nm. --max-size is also\n"
"                            required.\n"
"     --max-size=<s>        Use <s> as the maximum crystal size in nm.\n"
"                            --min-size is also required.\n"
Thomas White's avatar
Thomas White committed
93
94
95
96
97
"\n"
"By default, the simulation aims to be as accurate as possible.  For greater\n"
"speed, or for testing, you can choose to disable certain things using the\n"
"following options.\n"
"\n"
98
"     --no-water            Do not simulate water background.\n"
Thomas White's avatar
Thomas White committed
99
"     --no-noise            Do not calculate Poisson noise.\n"
100
);
Thomas White's avatar
Thomas White committed
101
102
103
}


104
static void show_details()
Thomas White's avatar
Thomas White committed
105
{
Thomas White's avatar
Thomas White committed
106
107
108
109
110
	printf(
"This program simulates diffraction patterns from small crystals illuminated\n"
"with femtosecond X-ray pulses from a free electron laser.\n"
"\n"
"The lattice transform from the specified number of unit cells is calculated\n"
111
112
"using the closed-form solution for a truncated lattice faceted on the\n"
"(001), (010) and (100) planes:\n"
Thomas White's avatar
Thomas White committed
113
"\n"
114
115
116
"I_latt(q) =  sin^2(pi*na*q.a)/sin^2(pi*q.a)\n"
"           * sin^2(pi*nb*q.b)/sin^2(pi*q.b)\n"
"           * sin^2(pi*nc*q.c)/sin^2(pi*q.c)\n"
Thomas White's avatar
Thomas White committed
117
118
119
120
"\n"
"na = number of unit cells in 'a' direction (likewise nb, nc)\n"
" q = reciprocal vector (1/d convention, not 2pi/d)\n"
"\n"
121
122
123
"This is multiplied by a model of the underlying molecular transform, I_mol(q).\n"
"This can be approximated to varying levels of accuracy by the methods given by\n"
"the '--gradients' option.\n"
Thomas White's avatar
Thomas White committed
124
"\n"
125
126
"Intensity from water is added according to the first term of equation 5\n"
"from Phys Chem Chem Phys 2003 (5) 1981--1991.  This simulates the\n"
127
"coherent, elastic part of the diffuse scattering from the water jet only.\n"
Thomas White's avatar
Thomas White committed
128
129
130
"\n"
"Expected intensities at the CCD are then calculated using:\n"
"\n"
131
"I(q) = I0 * r^2 * I_latt(q) * I_mol(q) * S\n"
Thomas White's avatar
Thomas White committed
132
133
134
135
"\n"
"I0 = number of photons per unit area in the incident beam\n"
" r = Thomson radius\n"
" S = solid angle of corresponding pixel\n"
136
137
138
"\n"
"Polarisation is not currently included in pattern_sim, although it is included\n"
"in the analysis of Bragg peaks by 'indexamajig'.\n"
Thomas White's avatar
Thomas White committed
139
140
"\n"
"Poisson counts are generated from the expected intensities using Knuth's\n"
Thomas White's avatar
Thomas White committed
141
142
143
"algorithm.  When the intensity is sufficiently high that Knuth's algorithm\n"
"would result in machine precision problems, a normal distribution with\n"
"standard deviation sqrt(I) is used instead.\n"
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
}


static struct quaternion read_quaternion()
{
	do {

		int r;
		float w, x, y, z;
		char line[1024];
		char *rval;

		printf("Please input quaternion: w x y z\n");
		rval = fgets(line, 1023, stdin);
		if ( rval == NULL ) return invalid_quaternion();
		chomp(line);

		r = sscanf(line, "%f %f %f %f", &w, &x, &y, &z);
		if ( r == 4 ) {

			struct quaternion quat;

			quat.w = w;
			quat.x = x;
			quat.y = y;
			quat.z = z;

			return quat;

		} else {
175
			ERROR("Invalid rotation '%s'\n", line);
176
177
178
		}

	} while ( 1 );
179
180
181
}


182
183
184
185
186
187
188
189
190
191
192
193
static int random_ncells(double len, double min_nm, double max_nm)
{
	int min_cells, max_cells, wid;

	min_cells = min_nm*1e-9 / len;
	max_cells = max_nm*1e-9 / len;
	wid = max_cells - min_cells;

	return wid*random()/RAND_MAX + min_cells;
}


194
195
int main(int argc, char *argv[])
{
196
	int c;
197
	struct image image;
198
	struct gpu_context *gctx = NULL;
199
	double *powder;
200
201
	char *intfile = NULL;
	double *intensities;
202
	double *phases;
Thomas White's avatar
Thomas White committed
203
	int config_simdetails = 0;
204
205
	int config_nearbragg = 0;
	int config_randomquat = 0;
206
	int config_noimages = 0;
207
	int config_nowater = 0;
Thomas White's avatar
Thomas White committed
208
	int config_nonoise = 0;
209
	int config_nosfac = 0;
210
	int config_gpu = 0;
211
	int config_random = 0;
212
	char *powder_fn = NULL;
213
	char *filename = NULL;
214
	char *grad_str = NULL;
215
	char *outfile = NULL;
Thomas White's avatar
Thomas White committed
216
	char *geometry = NULL;
217
	char *beamfile = NULL;
218
	GradientMethod grad;
Thomas White's avatar
Thomas White committed
219
220
221
	int ndone = 0;    /* Number of simulations done (images or not) */
	int number = 1;   /* Number used for filename of image */
	int n_images = 1; /* Generate one image by default */
222
	int done = 0;
Thomas White's avatar
Thomas White committed
223
224
	UnitCell *input_cell;
	struct quaternion orientation;
Thomas White's avatar
Thomas White committed
225
	int gpu_dev = -1;
226
227
228
	int random_size = 0;
	double min_size = 0.0;
	double max_size = 0.0;
Thomas White's avatar
Thomas White committed
229

230
	/* Long options */
Thomas White's avatar
Thomas White committed
231
	const struct option longopts[] = {
232
233
		{"help",               0, NULL,               'h'},
		{"simulation-details", 0, &config_simdetails,  1},
234
		{"gpu",                0, &config_gpu,         1},
235
236
237
		{"near-bragg",         0, &config_nearbragg,   1},
		{"random-orientation", 0, NULL,               'r'},
		{"number",             1, NULL,               'n'},
Thomas White's avatar
Thomas White committed
238
		{"no-images",          0, &config_noimages,    1},
239
		{"no-water",           0, &config_nowater,     1},
Thomas White's avatar
Thomas White committed
240
		{"no-noise",           0, &config_nonoise,     1},
241
		{"intensities",        1, NULL,               'i'},
242
		{"powder",             1, NULL,               'w'},
Thomas White's avatar
Thomas White committed
243
		{"gradients",          1, NULL,               't'},
244
		{"pdb",                1, NULL,               'p'},
245
		{"output",             1, NULL,               'o'},
Thomas White's avatar
Thomas White committed
246
		{"geometry",           1, NULL,               'g'},
247
		{"beam",               1, NULL,               'b'},
248
		{"really-random",      0, &config_random,      1},
Thomas White's avatar
Thomas White committed
249
		{"gpu-dev",            1, NULL,                2},
250
251
		{"min-size",           1, NULL,                3},
		{"max-size",           1, NULL,                4},
252
		{0, 0, NULL, 0}
Thomas White's avatar
Thomas White committed
253
	};
254

255
	/* Short options */
256
	while ((c = getopt_long(argc, argv, "hrn:i:t:p:o:g:b:",
Thomas White's avatar
Thomas White committed
257
	                        longopts, NULL)) != -1) {
258

Thomas White's avatar
Thomas White committed
259
		switch (c) {
Thomas White's avatar
Thomas White committed
260
		case 'h' :
Thomas White's avatar
Thomas White committed
261
262
			show_help(argv[0]);
			return 0;
263

Thomas White's avatar
Thomas White committed
264
		case 'r' :
265
266
267
			config_randomquat = 1;
			break;

Thomas White's avatar
Thomas White committed
268
		case 'n' :
269
270
271
			n_images = atoi(optarg);
			break;

Thomas White's avatar
Thomas White committed
272
		case 'i' :
273
274
275
			intfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
276
		case 't' :
277
278
279
			grad_str = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
280
		case 'p' :
281
282
283
			filename = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
284
		case 'o' :
285
286
287
			outfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
288
		case 'w' :
289
290
291
			powder_fn = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
292
		case 'g' :
Thomas White's avatar
Thomas White committed
293
294
295
			geometry = strdup(optarg);
			break;

296
297
298
299
		case 'b' :
			beamfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
300
301
302
303
		case 2 :
			gpu_dev = atoi(optarg);
			break;

304
305
306
307
308
309
310
311
312
313
		case 3 :
			min_size = atof(optarg);
			random_size++;
			break;

		case 4 :
			max_size = atof(optarg);
			random_size++;
			break;

Thomas White's avatar
Thomas White committed
314
		case 0 :
Thomas White's avatar
Thomas White committed
315
			break;
316

Thomas White's avatar
Thomas White committed
317
		default :
Thomas White's avatar
Thomas White committed
318
319
			return 1;
		}
320
321
322

	}

323
	if ( config_random ) {
324
325
326
327
328
329
330
331
		FILE *fh;
		unsigned int seed;
		fh = fopen("/dev/urandom", "r");
		fread(&seed, sizeof(seed), 1, fh);
		fclose(fh);
		srand(seed);
	}

332
333
334
335
336
	if ( random_size == 1 ) {
		ERROR("You must specify both --min-size and --max-size.\n");
		return 1;
	}

337
338
339
340
	if ( filename == NULL ) {
		filename = strdup("molecule.pdb");
	}

341
342
343
344
345
346
347
348
	if ( outfile == NULL ) {
		if ( n_images == 1 ) {
			outfile = strdup("sim.h5");
		} else {
			outfile = strdup("sim");
		}
	}

Thomas White's avatar
Thomas White committed
349
	if ( config_simdetails ) {
350
		show_details();
Thomas White's avatar
Thomas White committed
351
352
353
		return 0;
	}

354
355
356
357
358
359
	if ( (!config_nowater) && config_gpu ) {
		ERROR("Cannot simulate water scattering on the GPU.\n");
		ERROR("Please try again with the --no-water option.\n");
		return 1;
	}

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
	if ( grad_str == NULL ) {
		STATUS("You didn't specify a gradient calculation method, so"
		       " I'm using the 'mosaic' method, which is fastest.\n");
		grad = GRADIENT_MOSAIC;
	} else if ( strcmp(grad_str, "mosaic") == 0 ) {
		grad = GRADIENT_MOSAIC;
	} else if ( strcmp(grad_str, "interpolate") == 0) {
		grad = GRADIENT_INTERPOLATE;
	} else if ( strcmp(grad_str, "phased") == 0) {
		grad = GRADIENT_PHASED;
	} else {
		ERROR("Unrecognised gradient method '%s'\n", grad_str);
		return 1;
	}
	free(grad_str);

	if ( config_gpu && (grad != GRADIENT_MOSAIC) ) {
		ERROR("Only the mosaic method can be used for gradients when"
		      "calculating on the GPU.\n");
		return 1;
	}

Thomas White's avatar
Thomas White committed
382
383
384
385
386
	if ( geometry == NULL ) {
		ERROR("You need to specify a geometry file with --geometry\n");
		return 1;
	}

387
388
389
390
391
392
	if ( beamfile == NULL ) {
		ERROR("You need to specify a beam parameter file"
		      " with --beam\n");
		return 1;
	}

393
394
395
396
397
398
399
400
	if ( intfile == NULL ) {
		/* Gentle reminder */
		STATUS("You didn't specify the file containing the ");
		STATUS("reflection intensities (with --intensities).\n");
		STATUS("I'll simulate a flat intensity distribution.\n");
		intensities = NULL;
		phases = NULL;
	} else {
Thomas White's avatar
Thomas White committed
401
		ReflItemList *items;
402
403
404
405
406
		if ( grad == GRADIENT_PHASED ) {
			phases = new_list_phase();
		} else {
			phases = NULL;
		}
Thomas White's avatar
Thomas White committed
407
408
		intensities = new_list_intensity();
		phases = new_list_phase();
409
410
		items = read_reflections(intfile, intensities, phases,
		                         NULL, NULL);
411
		free(intfile);
Thomas White's avatar
Thomas White committed
412
		delete_items(items);
413
414
	}

415
416
417
418
419
420
421
	image.det = get_detector_geometry(geometry);
	if ( image.det == NULL ) {
		ERROR("Failed to read detector geometry from '%s'\n", geometry);
		return 1;
	}
	free(geometry);

422
423
424
425
426
427
428
	image.beam = get_beam_parameters(beamfile);
	if ( image.beam == NULL ) {
		ERROR("Failed to read beam parameters from '%s'\n", beamfile);
		return 1;
	}
	free(beamfile);

Thomas White's avatar
Thomas White committed
429
	/* Define image parameters */
430
431
	image.width = image.det->max_x + 1;
	image.height = image.det->max_y + 1;
432
	image.lambda = ph_en_to_lambda(eV_to_J(image.beam->photon_energy));
Thomas White's avatar
Thomas White committed
433
434
435
436

	/* Load unit cell */
	input_cell = load_cell_from_pdb(filename);
	if ( input_cell == NULL ) {
Thomas White's avatar
Thomas White committed
437
438
		exit(1);
	}
Thomas White's avatar
Thomas White committed
439
440

	/* Initialise stuff */
441
	image.filename = NULL;
Thomas White's avatar
Thomas White committed
442
443
	image.features = NULL;
	image.flags = NULL;
444
445
	image.f0 = 1.0;
	image.f0_available = 1;
Thomas White's avatar
Thomas White committed
446

447
448
	powder = calloc(image.width*image.height, sizeof(*powder));

Thomas White's avatar
Thomas White committed
449
	/* Splurge a few useful numbers */
450
	STATUS("Wavelength is %f nm\n", image.lambda/1.0e-9);
Thomas White's avatar
Thomas White committed
451

452
453
	do {

Thomas White's avatar
Thomas White committed
454
		int na, nb, nc;
455
		double a, b, c, d;
Thomas White's avatar
Thomas White committed
456
		UnitCell *cell;
Thomas White's avatar
Thomas White committed
457

458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
		if ( random_size ) {

			double alen, blen, clen, dis;

			cell_get_parameters(input_cell, &alen, &blen, &clen,
			                    &dis, &dis, &dis);

			na = random_ncells(alen, min_size, max_size);
			nb = random_ncells(blen, min_size, max_size);
			nc = random_ncells(clen, min_size, max_size);

		} else {

			na = 8;
			nb = 8;
			nc = 8;

		}
Thomas White's avatar
Thomas White committed
476

477
478
		/* Read quaternion from stdin */
		if ( config_randomquat ) {
Thomas White's avatar
Thomas White committed
479
			orientation = random_quaternion();
480
		} else {
Thomas White's avatar
Thomas White committed
481
			orientation = read_quaternion();
482
483
		}

Thomas White's avatar
Thomas White committed
484
		STATUS("Orientation is %5.3f %5.3f %5.3f %5.3f\n",
Thomas White's avatar
Thomas White committed
485
486
		       orientation.w, orientation.x,
		       orientation.y, orientation.z);
Thomas White's avatar
Thomas White committed
487

Thomas White's avatar
Thomas White committed
488
		if ( !quaternion_valid(orientation) ) {
489
			ERROR("Orientation modulus is not zero!\n");
490
491
492
			return 1;
		}

Thomas White's avatar
Thomas White committed
493
494
		cell = cell_rotate(input_cell, orientation);

495
496
497
		/* Ensure no residual information */
		image.data = NULL;
		image.twotheta = NULL;
498

499
		cell_get_parameters(cell, &a, &b, &c, &d, &d, &d);
500
501
502
		STATUS("Particle size = %i x %i x %i (=%5.2f x %5.2f x %5.2f nm)\n",
	               na, nb, nc, na*a/1.0e-9, nb*b/1.0e-9, nc*c/1.0e-9);

503
		if ( config_gpu ) {
504
505
			if ( gctx == NULL ) {
				gctx = setup_gpu(config_nosfac, &image,
Thomas White's avatar
Thomas White committed
506
				                 intensities, gpu_dev);
507
			}
508
			get_diffraction_gpu(gctx, &image, na, nb, nc, cell);
509
		} else {
Thomas White's avatar
Thomas White committed
510
511
			get_diffraction(&image, na, nb, nc, intensities, phases,
			                cell, !config_nowater, grad);
512
		}
513
		if ( image.data == NULL ) {
514
515
516
517
			ERROR("Diffraction calculation failed.\n");
			goto skip;
		}

518
		record_image(&image, !config_nonoise);
Thomas White's avatar
Thomas White committed
519

Thomas White's avatar
Thomas White committed
520
		if ( config_nearbragg ) {
521
			find_projected_peaks(&image, cell, 0, 0.1);
522
523
			output_intensities(&image, cell, NULL, 0, 1, 0, stdout,
			                   0, 0.1);
Thomas White's avatar
Thomas White committed
524
			free(image.cpeaks);
Thomas White's avatar
Thomas White committed
525
526
		}

527
		if ( powder_fn != NULL ) {
528
529
530
531
532
533
534

			int x, y, w;

			w = image.width;

			for ( x=0; x<image.width; x++ ) {
			for ( y=0; y<image.height; y++ ) {
535
				powder[x+w*y] += (double)image.data[x+w*y];
536
537
538
539
			}
			}

			if ( !(ndone % 10) ) {
540
				hdf5_write(powder_fn, powder,
541
				           image.width, image.height,
542
				           H5T_NATIVE_DOUBLE);
543
544
545
			}
		}

546
547
548
549
		if ( !config_noimages ) {

			char filename[1024];

550
551
552
553
554
555
556
			if ( n_images != 1 ) {
				snprintf(filename, 1023, "%s-%i.h5",
				         outfile, number);
			} else {
				strncpy(filename, outfile, 1023);
			}

557
			number++;
Thomas White's avatar
Thomas White committed
558

559
560
			/* Write the output file */
			hdf5_write(filename, image.data,
561
			           image.width, image.height, H5T_NATIVE_FLOAT);
562
563

		}
564

565
566
567
		/* Clean up */
		free(image.data);
		free(image.twotheta);
Thomas White's avatar
Thomas White committed
568
		cell_free(cell);
Thomas White's avatar
Thomas White committed
569

570
skip:
Thomas White's avatar
Thomas White committed
571
		ndone++;
572

573
		if ( n_images && (ndone >= n_images) ) done = 1;
Thomas White's avatar
Thomas White committed
574

575
	} while ( !done );
576

577
578
579
580
	if ( gctx != NULL ) {
		cleanup_gpu(gctx);
	}

Thomas White's avatar
Thomas White committed
581
582
	free(image.det->panels);
	free(image.det);
583
	free(image.beam);
584
	free(powder);
Thomas White's avatar
Thomas White committed
585
	cell_free(input_cell);
586
	free(intensities);
Thomas White's avatar
Thomas White committed
587
588
	free(outfile);
	free(filename);
589

590
	return 0;
591
}