pattern_sim.c 10.5 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
35


Thomas White's avatar
Thomas White committed
36
static void show_help(const char *s)
37
{
38
	printf("Syntax: %s [options]\n\n", s);
Thomas White's avatar
Thomas White committed
39
	printf(
Thomas White's avatar
Thomas White committed
40
"Simulate diffraction patterns from small crystals probed with femtosecond\n"
Thomas White's avatar
Thomas White committed
41
42
"pulses of X-rays from a free electron laser.\n"
"\n"
43
44
" -h, --help                Display this help message.\n"
"     --simulation-details  Show technical details of the simulation.\n"
45
"     --gpu                 Use the GPU to speed up the calculation.\n"
46
47
48
49
"\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"
Thomas White's avatar
Thomas White committed
50
" -r, --random-orientation  Use a randomly generated orientation\n"
51
"                            (a new orientation will be used for each image).\n"
Thomas White's avatar
Thomas White committed
52
53
"     --powder              Write a summed pattern of all images simulated by\n"
"                            this invocation to results/integr.h5.\n"
54
55
" -i, --intensities=<file>  Specify file containing reflection intensities\n"
"                            to use.\n"
56
57
58
59
60
61
62
63
" -g, --gradients=<method>  Use <method> for the calculation of shape\n"
"                            transform intensities.  Choose from:\n"
"                             mosaic      : Take the intensity of the nearest\n"
"                                           Bragg position.\n"
"                             interpolate : Interpolate trilinearly between\n"
"                                           six adjacent Bragg intensities.\n"
"                             phased      : As 'interpolate', but take phase\n"
"                                           values into account.\n"
Thomas White's avatar
Thomas White committed
64
65
66
67
68
"\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"
69
"     --no-water            Do not simulate water background.\n"
Thomas White's avatar
Thomas White committed
70
"     --no-noise            Do not calculate Poisson noise.\n"
71
);
Thomas White's avatar
Thomas White committed
72
73
74
}


75
static void show_details()
Thomas White's avatar
Thomas White committed
76
{
Thomas White's avatar
Thomas White committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
	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"
"using the closed-form solution for a truncated lattice:\n"
"\n"
"F(q) =  sin(pi*na*q.a)/sin(pi*q.a)\n"
"      * sin(pi*nb*q.b)/sin(pi*q.b)\n"
"      * sin(pi*nc*q.c)/sin(pi*q.c)\n"
"\n"
"na = number of unit cells in 'a' direction (likewise nb, nc)\n"
" q = reciprocal vector (1/d convention, not 2pi/d)\n"
"\n"
91
"This square modulus of this value is taken, and multiplied by the Bragg\n"
92
93
94
95
"intensitiy at the neares Bragg position.  That means that the gradient of\n"
"the underlying molecule transform is not included, for speed of calculation.\n"
"The Bragg intensities are taken from the file specified on the command line\n"
"with the --intensities option.\n"
Thomas White's avatar
Thomas White committed
96
"\n"
97
98
99
"Intensity from water is then added according to the first term of equation\n"
"5 from Phys Chem Chem Phys 2003 (5) 1981--1991.  This simulates the\n"
"coherent, elastic part of the diffuse scattering from the water jet only.\n"
Thomas White's avatar
Thomas White committed
100
101
102
103
104
105
106
107
"\n"
"Expected intensities at the CCD are then calculated using:\n"
"\n"
"I(q) = I0 * r^2 * |F(q)|^2 * S\n"
"\n"
"I0 = number of photons per unit area in the incident beam\n"
" r = Thomson radius\n"
" S = solid angle of corresponding pixel\n"
108
"where |F(q)|^2 is the value calculated as described above.\n"
Thomas White's avatar
Thomas White committed
109
110
"\n"
"Poisson counts are generated from the expected intensities using Knuth's\n"
Thomas White's avatar
Thomas White committed
111
112
113
"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"
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
}


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 {
145
			ERROR("Invalid rotation '%s'\n", line);
146
147
148
		}

	} while ( 1 );
149
150
151
152
153
}


int main(int argc, char *argv[])
{
154
	int c;
155
	struct image image;
156
	struct gpu_context *gctx = NULL;
157
	double *powder;
158
159
	char *intfile = NULL;
	double *intensities;
Thomas White's avatar
Thomas White committed
160
	int config_simdetails = 0;
161
162
	int config_nearbragg = 0;
	int config_randomquat = 0;
163
	int config_noimages = 0;
164
	int config_nowater = 0;
Thomas White's avatar
Thomas White committed
165
	int config_nonoise = 0;
166
	int config_nosfac = 0;
167
	int config_gpu = 0;
168
	int config_powder = 0;
169
170
	char *grad_str = NULL;
	GradientMethod grad;
Thomas White's avatar
Thomas White committed
171
172
173
	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 */
174
	int done = 0;
175
	UnitCell *cell;
176
	unsigned int *counts;
Thomas White's avatar
Thomas White committed
177

178
	/* Long options */
Thomas White's avatar
Thomas White committed
179
	const struct option longopts[] = {
180
181
		{"help",               0, NULL,               'h'},
		{"simulation-details", 0, &config_simdetails,  1},
182
		{"gpu",                0, &config_gpu,         1},
183
184
185
		{"near-bragg",         0, &config_nearbragg,   1},
		{"random-orientation", 0, NULL,               'r'},
		{"number",             1, NULL,               'n'},
Thomas White's avatar
Thomas White committed
186
		{"no-images",          0, &config_noimages,    1},
187
		{"no-water",           0, &config_nowater,     1},
Thomas White's avatar
Thomas White committed
188
		{"no-noise",           0, &config_nonoise,     1},
189
		{"intensities",        1, NULL,               'i'},
190
		{"powder",             0, &config_powder,      1},
191
		{"gradients",          1, NULL,               'g'},
192
		{0, 0, NULL, 0}
Thomas White's avatar
Thomas White committed
193
	};
194

195
	/* Short options */
196
	while ((c = getopt_long(argc, argv, "hrn:i:g:", longopts, NULL)) != -1) {
197

Thomas White's avatar
Thomas White committed
198
199
200
201
202
		switch (c) {
		case 'h' : {
			show_help(argv[0]);
			return 0;
		}
203

204
205
206
207
208
209
210
211
212
213
		case 'r' : {
			config_randomquat = 1;
			break;
		}

		case 'n' : {
			n_images = atoi(optarg);
			break;
		}

214
215
216
217
218
		case 'i' : {
			intfile = strdup(optarg);
			break;
		}

219
220
221
222
223
		case 'g' : {
			grad_str = strdup(optarg);
			break;
		}

Thomas White's avatar
Thomas White committed
224
225
226
		case 0 : {
			break;
		}
227

Thomas White's avatar
Thomas White committed
228
229
230
		default : {
			return 1;
		}
231
232
233
234
		}

	}

Thomas White's avatar
Thomas White committed
235
	if ( config_simdetails ) {
236
		show_details();
Thomas White's avatar
Thomas White committed
237
238
239
		return 0;
	}

240
241
242
243
244
245
	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;
	}

246
247
248
249
250
251
	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;
252
		counts = NULL;
253
	} else {
254
255
		counts = new_list_count();
		intensities = read_reflections(intfile, counts);
256
257
258
		free(intfile);
	}

259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
	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
281
	/* Define image parameters */
Thomas White's avatar
Thomas White committed
282
283
	image.width = 1024;
	image.height = 1024;
Thomas White's avatar
Thomas White committed
284
	image.lambda = ph_en_to_lambda(eV_to_J(1790.0));  /* Wavelength */
285
	cell = load_cell_from_pdb("molecule.pdb");
286
	image.filename = NULL;
Thomas White's avatar
Thomas White committed
287

Thomas White's avatar
Thomas White committed
288
	#include "geometry-lcls.tmp"
289

290
291
	powder = calloc(image.width*image.height, sizeof(*powder));

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

295
296
	do {

Thomas White's avatar
Thomas White committed
297
		int na, nb, nc;
298
		double a, b, c, d;
Thomas White's avatar
Thomas White committed
299

300
301
302
		//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
303
304
305
		na = 24;
		nb = 24;
		nc = 40;
Thomas White's avatar
Thomas White committed
306

307
308
309
		/* Read quaternion from stdin */
		if ( config_randomquat ) {
			image.orientation = random_quaternion();
310
		} else {
311
			image.orientation = read_quaternion();
312
313
		}

Thomas White's avatar
Thomas White committed
314
315
316
317
		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
318
		if ( !quaternion_valid(image.orientation) ) {
319
			ERROR("Orientation modulus is not zero!\n");
320
321
322
323
324
325
			return 1;
		}

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

327
		cell_get_parameters(cell, &a, &b, &c, &d, &d, &d);
328
329
330
		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);

331
		if ( config_gpu ) {
332
333
			if ( gctx == NULL ) {
				gctx = setup_gpu(config_nosfac, &image,
334
				                 intensities, counts);
335
			}
336
			get_diffraction_gpu(gctx, &image, na, nb, nc, cell);
337
		} else {
338
			get_diffraction(&image, na, nb, nc, intensities, counts,
339
			                cell, !config_nowater, grad);
340
		}
341
		if ( image.data == NULL ) {
342
343
344
345
			ERROR("Diffraction calculation failed.\n");
			goto skip;
		}

346
		record_image(&image, !config_nonoise);
Thomas White's avatar
Thomas White committed
347

Thomas White's avatar
Thomas White committed
348
		if ( config_nearbragg ) {
349
			output_intensities(&image, cell, NULL, 1);
Thomas White's avatar
Thomas White committed
350
351
		}

352
353
354
355
356
357
358
359
		if ( config_powder ) {

			int x, y, w;

			w = image.width;

			for ( x=0; x<image.width; x++ ) {
			for ( y=0; y<image.height; y++ ) {
360
				powder[x+w*y] += (double)image.data[x+w*y];
361
362
363
364
			}
			}

			if ( !(ndone % 10) ) {
365
				hdf5_write("results/integr.h5", powder,
366
				           image.width, image.height,
367
				           H5T_NATIVE_DOUBLE);
368
369
370
			}
		}

371
372
373
374
375
376
		if ( !config_noimages ) {

			char filename[1024];

			snprintf(filename, 1023, "results/sim-%i.h5", number);
			number++;
Thomas White's avatar
Thomas White committed
377

378
379
			/* Write the output file */
			hdf5_write(filename, image.data,
380
			           image.width, image.height, H5T_NATIVE_FLOAT);
381
382

		}
383

384
385
386
		/* Clean up */
		free(image.data);
		free(image.twotheta);
Thomas White's avatar
Thomas White committed
387

388
skip:
Thomas White's avatar
Thomas White committed
389
		ndone++;
390

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

393
	} while ( !done );
394

395
396
397
398
	if ( gctx != NULL ) {
		cleanup_gpu(gctx);
	}

399
400
	free(image.det.panels);
	free(powder);
401
402
	free(cell);
	free(intensities);
403

404
	return 0;
405
}