pattern_sim.c 9.04 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"
Thomas White's avatar
Thomas White committed
56
57
58
59
60
"\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"
61
"     --no-water            Do not simulate water background.\n"
Thomas White's avatar
Thomas White committed
62
"     --no-noise            Do not calculate Poisson noise.\n"
63
);
Thomas White's avatar
Thomas White committed
64
65
66
}


67
static void show_details()
Thomas White's avatar
Thomas White committed
68
{
Thomas White's avatar
Thomas White committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
	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"
83
"This square modulus of this value is taken, and multiplied by the Bragg\n"
84
85
86
87
"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
88
"\n"
89
90
91
"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
92
93
94
95
96
97
98
99
"\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"
100
"where |F(q)|^2 is the value calculated as described above.\n"
Thomas White's avatar
Thomas White committed
101
102
"\n"
"Poisson counts are generated from the expected intensities using Knuth's\n"
Thomas White's avatar
Thomas White committed
103
104
105
"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"
106
);
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
}


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 {
137
			ERROR("Invalid rotation '%s'\n", line);
138
139
140
		}

	} while ( 1 );
141
142
143
144
145
}


int main(int argc, char *argv[])
{
146
	int c;
147
	struct image image;
148
	struct gpu_context *gctx = NULL;
149
	double *powder;
150
151
	char *intfile = NULL;
	double *intensities;
Thomas White's avatar
Thomas White committed
152
	int config_simdetails = 0;
153
154
	int config_nearbragg = 0;
	int config_randomquat = 0;
155
	int config_noimages = 0;
156
	int config_nowater = 0;
Thomas White's avatar
Thomas White committed
157
	int config_nonoise = 0;
158
	int config_nosfac = 0;
159
	int config_gpu = 0;
160
	int config_powder = 0;
Thomas White's avatar
Thomas White committed
161
162
163
	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 */
164
	int done = 0;
165
	UnitCell *cell;
166
	unsigned int *counts;
Thomas White's avatar
Thomas White committed
167

168
	/* Long options */
Thomas White's avatar
Thomas White committed
169
	const struct option longopts[] = {
170
171
		{"help",               0, NULL,               'h'},
		{"simulation-details", 0, &config_simdetails,  1},
172
		{"gpu",                0, &config_gpu,         1},
173
174
175
		{"near-bragg",         0, &config_nearbragg,   1},
		{"random-orientation", 0, NULL,               'r'},
		{"number",             1, NULL,               'n'},
Thomas White's avatar
Thomas White committed
176
		{"no-images",          0, &config_noimages,    1},
177
		{"no-water",           0, &config_nowater,     1},
Thomas White's avatar
Thomas White committed
178
		{"no-noise",           0, &config_nonoise,     1},
179
		{"intensities",        1, NULL,               'i'},
180
		{"powder",             0, &config_powder,      1},
181
		{0, 0, NULL, 0}
Thomas White's avatar
Thomas White committed
182
	};
183

184
	/* Short options */
185
	while ((c = getopt_long(argc, argv, "hrn:i:", longopts, NULL)) != -1) {
186

Thomas White's avatar
Thomas White committed
187
188
189
190
191
		switch (c) {
		case 'h' : {
			show_help(argv[0]);
			return 0;
		}
192

193
194
195
196
197
198
199
200
201
202
		case 'r' : {
			config_randomquat = 1;
			break;
		}

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

203
204
205
206
207
		case 'i' : {
			intfile = strdup(optarg);
			break;
		}

Thomas White's avatar
Thomas White committed
208
209
210
		case 0 : {
			break;
		}
211

Thomas White's avatar
Thomas White committed
212
213
214
		default : {
			return 1;
		}
215
216
217
218
		}

	}

Thomas White's avatar
Thomas White committed
219
	if ( config_simdetails ) {
220
		show_details();
Thomas White's avatar
Thomas White committed
221
222
223
		return 0;
	}

224
225
226
227
228
229
	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;
	}

230
231
232
233
234
235
	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;
236
		counts = NULL;
237
	} else {
238
239
		counts = new_list_count();
		intensities = read_reflections(intfile, counts);
240
241
242
		free(intfile);
	}

Thomas White's avatar
Thomas White committed
243
	/* Define image parameters */
Thomas White's avatar
Thomas White committed
244
245
	image.width = 1024;
	image.height = 1024;
Thomas White's avatar
Thomas White committed
246
	image.lambda = ph_en_to_lambda(eV_to_J(1790.0));  /* Wavelength */
247
	cell = load_cell_from_pdb("molecule.pdb");
248
	image.filename = NULL;
Thomas White's avatar
Thomas White committed
249

Thomas White's avatar
Thomas White committed
250
	#include "geometry-lcls.tmp"
251

252
253
	powder = calloc(image.width*image.height, sizeof(*powder));

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

257
258
	do {

Thomas White's avatar
Thomas White committed
259
		int na, nb, nc;
260
		double a, b, c, d;
Thomas White's avatar
Thomas White committed
261

262
263
264
		//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
265
266
267
		na = 24;
		nb = 24;
		nc = 40;
Thomas White's avatar
Thomas White committed
268

269
270
271
		/* Read quaternion from stdin */
		if ( config_randomquat ) {
			image.orientation = random_quaternion();
272
		} else {
273
			image.orientation = read_quaternion();
274
275
		}

Thomas White's avatar
Thomas White committed
276
277
278
279
		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
280
		if ( !quaternion_valid(image.orientation) ) {
281
			ERROR("Orientation modulus is not zero!\n");
282
283
284
285
286
287
			return 1;
		}

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

289
		cell_get_parameters(cell, &a, &b, &c, &d, &d, &d);
290
291
292
		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);

293
		if ( config_gpu ) {
294
295
			if ( gctx == NULL ) {
				gctx = setup_gpu(config_nosfac, &image,
296
				                 intensities, counts);
297
			}
298
			get_diffraction_gpu(gctx, &image, na, nb, nc, cell);
299
		} else {
300
301
			get_diffraction(&image, na, nb, nc, intensities, counts,
			                cell, !config_nowater);
302
		}
303
		if ( image.data == NULL ) {
304
305
306
307
			ERROR("Diffraction calculation failed.\n");
			goto skip;
		}

308
		record_image(&image, !config_nonoise);
Thomas White's avatar
Thomas White committed
309

Thomas White's avatar
Thomas White committed
310
		if ( config_nearbragg ) {
311
			output_intensities(&image, cell, NULL);
Thomas White's avatar
Thomas White committed
312
313
		}

314
315
316
317
318
319
320
321
		if ( config_powder ) {

			int x, y, w;

			w = image.width;

			for ( x=0; x<image.width; x++ ) {
			for ( y=0; y<image.height; y++ ) {
322
				powder[x+w*y] += (double)image.data[x+w*y];
323
324
325
326
			}
			}

			if ( !(ndone % 10) ) {
327
				hdf5_write("results/integr.h5", powder,
328
				           image.width, image.height,
329
				           H5T_NATIVE_DOUBLE);
330
331
332
			}
		}

333
334
335
336
337
338
		if ( !config_noimages ) {

			char filename[1024];

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

340
341
			/* Write the output file */
			hdf5_write(filename, image.data,
342
			           image.width, image.height, H5T_NATIVE_FLOAT);
343
344

		}
345

346
347
348
		/* Clean up */
		free(image.data);
		free(image.twotheta);
Thomas White's avatar
Thomas White committed
349

350
skip:
Thomas White's avatar
Thomas White committed
351
		ndone++;
352

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

355
	} while ( !done );
356

357
358
359
360
	if ( gctx != NULL ) {
		cleanup_gpu(gctx);
	}

361
362
	free(image.det.panels);
	free(powder);
363
364
	free(cell);
	free(intensities);
365

366
	return 0;
367
}