pattern_sim.c 14.1 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"
51
52
" -g, --geometry=<file>     Get detector geometry from file.\n"
" -b, --beam=<file>         Get beam parameters from file.\n"
53
54
55
56
"\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"
57
58
59
60
61
62
" -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
63
" -r, --random-orientation  Use a randomly generated orientation\n"
64
"                            (a new orientation will be used for each image).\n"
65
66
"     --powder=<file>       Write a summed pattern of all images simulated by\n"
"                            this invocation as the given filename.\n"
67
" -i, --intensities=<file>  Specify file containing reflection intensities\n"
Thomas White's avatar
Thomas White committed
68
"                            (and phases) to use.\n"
Thomas White's avatar
Thomas White committed
69
" -t, --gradients=<method>  Use <method> for the calculation of shape\n"
70
71
"                            transform intensities.  Choose from:\n"
"                             mosaic      : Take the intensity of the nearest\n"
Thomas White's avatar
Thomas White committed
72
73
74
"                                           Bragg position.  This is the\n"
"                                           fastest method and the only one\n"
"                                           supported on the GPU.\n"
75
76
"                             interpolate : Interpolate trilinearly between\n"
"                                           six adjacent Bragg intensities.\n"
Thomas White's avatar
Thomas White committed
77
78
"                                           This method has intermediate\n"
"                                           accuracy.\n"
79
"                             phased      : As 'interpolate', but take phase\n"
Thomas White's avatar
Thomas White committed
80
81
82
"                                           values into account.  This is the\n"
"                                           most accurate method, but the\n"
"                                           slowest.\n"
83
84
85
"     --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"
Thomas White's avatar
Thomas White committed
86
87
88
89
90
"\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"
91
"     --no-water            Do not simulate water background.\n"
Thomas White's avatar
Thomas White committed
92
"     --no-noise            Do not calculate Poisson noise.\n"
93
);
Thomas White's avatar
Thomas White committed
94
95
96
}


97
static void show_details()
Thomas White's avatar
Thomas White committed
98
{
Thomas White's avatar
Thomas White committed
99
100
101
102
103
	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"
104
105
"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
106
"\n"
107
108
109
"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
110
111
112
113
"\n"
"na = number of unit cells in 'a' direction (likewise nb, nc)\n"
" q = reciprocal vector (1/d convention, not 2pi/d)\n"
"\n"
114
115
116
"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
117
"\n"
118
119
"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"
120
"coherent, elastic part of the diffuse scattering from the water jet only.\n"
Thomas White's avatar
Thomas White committed
121
122
123
"\n"
"Expected intensities at the CCD are then calculated using:\n"
"\n"
124
"I(q) = I0 * r^2 * I_latt(q) * I_mol(q) * S\n"
Thomas White's avatar
Thomas White committed
125
126
127
128
"\n"
"I0 = number of photons per unit area in the incident beam\n"
" r = Thomson radius\n"
" S = solid angle of corresponding pixel\n"
129
130
131
"\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
132
133
"\n"
"Poisson counts are generated from the expected intensities using Knuth's\n"
Thomas White's avatar
Thomas White committed
134
135
136
"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"
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
}


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 {
168
			ERROR("Invalid rotation '%s'\n", line);
169
170
171
		}

	} while ( 1 );
172
173
174
175
176
}


int main(int argc, char *argv[])
{
177
	int c;
178
	struct image image;
179
	struct gpu_context *gctx = NULL;
180
	double *powder;
181
182
	char *intfile = NULL;
	double *intensities;
183
	double *phases;
Thomas White's avatar
Thomas White committed
184
	int config_simdetails = 0;
185
186
	int config_nearbragg = 0;
	int config_randomquat = 0;
187
	int config_noimages = 0;
188
	int config_nowater = 0;
Thomas White's avatar
Thomas White committed
189
	int config_nonoise = 0;
190
	int config_nosfac = 0;
191
	int config_gpu = 0;
192
	int config_random = 0;
193
	char *powder_fn = NULL;
194
	char *filename = NULL;
195
	char *grad_str = NULL;
196
	char *outfile = NULL;
Thomas White's avatar
Thomas White committed
197
	char *geometry = NULL;
198
	char *beamfile = NULL;
199
	GradientMethod grad;
Thomas White's avatar
Thomas White committed
200
201
202
	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 */
203
	int done = 0;
204
	UnitCell *cell;
Thomas White's avatar
Thomas White committed
205

206
	/* Long options */
Thomas White's avatar
Thomas White committed
207
	const struct option longopts[] = {
208
209
		{"help",               0, NULL,               'h'},
		{"simulation-details", 0, &config_simdetails,  1},
210
		{"gpu",                0, &config_gpu,         1},
211
212
213
		{"near-bragg",         0, &config_nearbragg,   1},
		{"random-orientation", 0, NULL,               'r'},
		{"number",             1, NULL,               'n'},
Thomas White's avatar
Thomas White committed
214
		{"no-images",          0, &config_noimages,    1},
215
		{"no-water",           0, &config_nowater,     1},
Thomas White's avatar
Thomas White committed
216
		{"no-noise",           0, &config_nonoise,     1},
217
		{"intensities",        1, NULL,               'i'},
218
		{"powder",             1, NULL,               'w'},
Thomas White's avatar
Thomas White committed
219
		{"gradients",          1, NULL,               't'},
220
		{"pdb",                1, NULL,               'p'},
221
		{"output",             1, NULL,               'o'},
Thomas White's avatar
Thomas White committed
222
		{"geometry",           1, NULL,               'g'},
223
		{"beam",               1, NULL,               'b'},
224
		{"really-random",      0, &config_random,      1},
225
		{0, 0, NULL, 0}
Thomas White's avatar
Thomas White committed
226
	};
227

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

Thomas White's avatar
Thomas White committed
232
		switch (c) {
Thomas White's avatar
Thomas White committed
233
		case 'h' :
Thomas White's avatar
Thomas White committed
234
235
			show_help(argv[0]);
			return 0;
236

Thomas White's avatar
Thomas White committed
237
		case 'r' :
238
239
240
			config_randomquat = 1;
			break;

Thomas White's avatar
Thomas White committed
241
		case 'n' :
242
243
244
			n_images = atoi(optarg);
			break;

Thomas White's avatar
Thomas White committed
245
		case 'i' :
246
247
248
			intfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
249
		case 't' :
250
251
252
			grad_str = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
253
		case 'p' :
254
255
256
			filename = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
257
		case 'o' :
258
259
260
			outfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
261
		case 'w' :
262
263
264
			powder_fn = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
265
		case 'g' :
Thomas White's avatar
Thomas White committed
266
267
268
			geometry = strdup(optarg);
			break;

269
270
271
272
		case 'b' :
			beamfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
273
		case 0 :
Thomas White's avatar
Thomas White committed
274
			break;
275

Thomas White's avatar
Thomas White committed
276
		default :
Thomas White's avatar
Thomas White committed
277
278
			return 1;
		}
279
280
281

	}

282
	if ( config_random ) {
283
284
285
286
287
288
289
290
		FILE *fh;
		unsigned int seed;
		fh = fopen("/dev/urandom", "r");
		fread(&seed, sizeof(seed), 1, fh);
		fclose(fh);
		srand(seed);
	}

291
292
293
294
	if ( filename == NULL ) {
		filename = strdup("molecule.pdb");
	}

295
296
297
298
299
300
301
302
	if ( outfile == NULL ) {
		if ( n_images == 1 ) {
			outfile = strdup("sim.h5");
		} else {
			outfile = strdup("sim");
		}
	}

Thomas White's avatar
Thomas White committed
303
	if ( config_simdetails ) {
304
		show_details();
Thomas White's avatar
Thomas White committed
305
306
307
		return 0;
	}

308
309
310
311
312
313
	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;
	}

314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
	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
336
337
338
339
340
	if ( geometry == NULL ) {
		ERROR("You need to specify a geometry file with --geometry\n");
		return 1;
	}

341
342
343
344
345
346
	if ( beamfile == NULL ) {
		ERROR("You need to specify a beam parameter file"
		      " with --beam\n");
		return 1;
	}

347
348
349
350
351
352
353
354
	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
355
		ReflItemList *items;
356
357
358
359
360
		if ( grad == GRADIENT_PHASED ) {
			phases = new_list_phase();
		} else {
			phases = NULL;
		}
Thomas White's avatar
Thomas White committed
361
362
		intensities = new_list_intensity();
		phases = new_list_phase();
363
364
		items = read_reflections(intfile, intensities, phases,
		                         NULL, NULL);
365
		free(intfile);
Thomas White's avatar
Thomas White committed
366
		delete_items(items);
367
368
	}

369
370
371
372
373
374
375
	image.det = get_detector_geometry(geometry);
	if ( image.det == NULL ) {
		ERROR("Failed to read detector geometry from '%s'\n", geometry);
		return 1;
	}
	free(geometry);

376
377
378
379
380
381
382
	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
383
	/* Define image parameters */
384
385
	image.width = image.det->max_x + 1;
	image.height = image.det->max_y + 1;
386
	image.lambda = ph_en_to_lambda(eV_to_J(image.beam->photon_energy));
387
	cell = load_cell_from_pdb(filename);
Thomas White's avatar
Thomas White committed
388
389
390
	if ( cell == NULL ) {
		exit(1);
	}
391
	image.filename = NULL;
Thomas White's avatar
Thomas White committed
392
393
	image.features = NULL;
	image.flags = NULL;
394
395
	image.f0 = 1.0;
	image.f0_available = 1;
Thomas White's avatar
Thomas White committed
396

397
398
	powder = calloc(image.width*image.height, sizeof(*powder));

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

402
403
	do {

Thomas White's avatar
Thomas White committed
404
		int na, nb, nc;
405
		double a, b, c, d;
Thomas White's avatar
Thomas White committed
406

407
408
409
		//na = 8*random()/RAND_MAX + 4;
		//nb = 8*random()/RAND_MAX + 4;
		//nc = 16*random()/RAND_MAX + 30;
Thomas White's avatar
Thomas White committed
410
411
412
		na = 24;
		nb = 24;
		nc = 40;
Thomas White's avatar
Thomas White committed
413

414
415
416
		/* Read quaternion from stdin */
		if ( config_randomquat ) {
			image.orientation = random_quaternion();
417
		} else {
418
			image.orientation = read_quaternion();
419
420
		}

Thomas White's avatar
Thomas White committed
421
422
423
424
		STATUS("Orientation is %5.3f %5.3f %5.3f %5.3f\n",
		       image.orientation.w, image.orientation.x,
		       image.orientation.y, image.orientation.z);

Thomas White's avatar
D'oh    
Thomas White committed
425
		if ( !quaternion_valid(image.orientation) ) {
426
			ERROR("Orientation modulus is not zero!\n");
427
428
429
430
431
432
			return 1;
		}

		/* Ensure no residual information */
		image.data = NULL;
		image.twotheta = NULL;
433

434
		cell_get_parameters(cell, &a, &b, &c, &d, &d, &d);
435
436
437
		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);

438
		if ( config_gpu ) {
439
440
			if ( gctx == NULL ) {
				gctx = setup_gpu(config_nosfac, &image,
Thomas White's avatar
Thomas White committed
441
				                 intensities);
442
			}
443
			get_diffraction_gpu(gctx, &image, na, nb, nc, cell);
444
		} else {
Thomas White's avatar
Thomas White committed
445
446
			get_diffraction(&image, na, nb, nc, intensities, phases,
			                cell, !config_nowater, grad);
447
		}
448
		if ( image.data == NULL ) {
449
450
451
452
			ERROR("Diffraction calculation failed.\n");
			goto skip;
		}

453
		record_image(&image, !config_nonoise);
Thomas White's avatar
Thomas White committed
454

Thomas White's avatar
Thomas White committed
455
		if ( config_nearbragg ) {
456
			find_projected_peaks(&image, cell, 0, 0.1);
457
458
			output_intensities(&image, cell, NULL, 0, 1, 0, stdout,
			                   0, 0.1);
Thomas White's avatar
Thomas White committed
459
			free(image.cpeaks);
Thomas White's avatar
Thomas White committed
460
461
		}

462
		if ( powder_fn != NULL ) {
463
464
465
466
467
468
469

			int x, y, w;

			w = image.width;

			for ( x=0; x<image.width; x++ ) {
			for ( y=0; y<image.height; y++ ) {
470
				powder[x+w*y] += (double)image.data[x+w*y];
471
472
473
474
			}
			}

			if ( !(ndone % 10) ) {
475
				hdf5_write(powder_fn, powder,
476
				           image.width, image.height,
477
				           H5T_NATIVE_DOUBLE);
478
479
480
			}
		}

481
482
483
484
		if ( !config_noimages ) {

			char filename[1024];

485
486
487
488
489
490
491
			if ( n_images != 1 ) {
				snprintf(filename, 1023, "%s-%i.h5",
				         outfile, number);
			} else {
				strncpy(filename, outfile, 1023);
			}

492
			number++;
Thomas White's avatar
Thomas White committed
493

494
495
			/* Write the output file */
			hdf5_write(filename, image.data,
496
			           image.width, image.height, H5T_NATIVE_FLOAT);
497
498

		}
499

500
501
502
		/* Clean up */
		free(image.data);
		free(image.twotheta);
Thomas White's avatar
Thomas White committed
503

504
skip:
Thomas White's avatar
Thomas White committed
505
		ndone++;
506

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

509
	} while ( !done );
510

511
512
513
514
	if ( gctx != NULL ) {
		cleanup_gpu(gctx);
	}

Thomas White's avatar
Thomas White committed
515
516
	free(image.det->panels);
	free(image.det);
517
	free(image.beam);
518
	free(powder);
519
	cell_free(cell);
520
	free(intensities);
Thomas White's avatar
Thomas White committed
521
522
	free(outfile);
	free(filename);
523

524
	return 0;
525
}