pattern_sim.c 8.95 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"
Thomas White's avatar
Thomas White committed
31
#include "intensities.h"
Thomas White's avatar
Thomas White committed
32
#include "sfac.h"
33
34


Thomas White's avatar
Thomas White committed
35
static void show_help(const char *s)
36
{
37
	printf("Syntax: %s [options]\n\n", s);
Thomas White's avatar
Thomas White committed
38
	printf(
Thomas White's avatar
Thomas White committed
39
"Simulate diffraction patterns from small crystals probed with femtosecond\n"
Thomas White's avatar
Thomas White committed
40
41
"pulses of X-rays from a free electron laser.\n"
"\n"
42
43
" -h, --help                Display this help message.\n"
"     --simulation-details  Show technical details of the simulation.\n"
44
"     --gpu                 Use the GPU to speed up the calculation.\n"
45
46
47
48
"\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
49
" -r, --random-orientation  Use a randomly generated orientation\n"
50
"                            (a new orientation will be used for each image).\n"
Thomas White's avatar
Thomas White committed
51
52
"     --powder              Write a summed pattern of all images simulated by\n"
"                            this invocation to results/integr.h5.\n"
Thomas White's avatar
Thomas White committed
53
54
55
56
57
"\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"
58
"     --no-water            Do not simulate water background.\n"
Thomas White's avatar
Thomas White committed
59
"     --no-noise            Do not calculate Poisson noise.\n"
Thomas White's avatar
Thomas White committed
60
"     --no-sfac             Pretend that all structure factors are 1.\n"
61
);
Thomas White's avatar
Thomas White committed
62
63
64
}


65
static void show_details()
Thomas White's avatar
Thomas White committed
66
{
Thomas White's avatar
Thomas White committed
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
	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"
"This value is multiplied by the complex structure factor at the nearest\n"
"Bragg position, i.e. the gradient of the shape transform across each\n"
"appearance of the shape transform is not included, for speed of calculation.\n"
"\n"
"Complex structure factors are calculated using a combination of the Henke\n"
"and Waasmeier-Kirfel scattering factors. The Henke factors are complex\n"
"and energy dependence, whereas the Waas-Kirf values are real-valued and\n"
"|q|-dependent.  The difference between the Waas-Kirf value at the\n"
"appropriate |q| and the same value at |q|=0 is subtracted from the Henke\n"
"value.  The Henke values are linearly interpolated from the provided tables\n"
"(note that the interpolation should really be exponential).\n"
"\n"
"The modulus of the structure factor is taken and squared.  Intensity from\n"
"water is then added according to the first term of equation 5 from\n"
Thomas White's avatar
Thomas White committed
95
"Phys Chem Chem Phys 2003 (5) 1981--1991.\n"
Thomas White's avatar
Thomas White committed
96
97
98
99
100
101
102
103
104
105
"\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"
"\n"
"Poisson counts are generated from the expected intensities using Knuth's\n"
Thomas White's avatar
Thomas White committed
106
107
108
"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"
109
110
111
"\n"
"The coherent, elastic part of the diffuse scattering from the water jet can\n"
"be simulated.\n"
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
137
138
139
140
141
142
}


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

	} while ( 1 );
147
148
149
150
151
}


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

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

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

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

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

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

Thomas White's avatar
Thomas White committed
205
206
207
		case 0 : {
			break;
		}
208

Thomas White's avatar
Thomas White committed
209
210
211
		default : {
			return 1;
		}
212
213
214
215
		}

	}

Thomas White's avatar
Thomas White committed
216
	if ( config_simdetails ) {
217
		show_details();
Thomas White's avatar
Thomas White committed
218
219
220
		return 0;
	}

221
222
223
224
225
226
	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;
	}

Thomas White's avatar
Thomas White committed
227
	/* Define image parameters */
Thomas White's avatar
Thomas White committed
228
229
	image.width = 1024;
	image.height = 1024;
230
	image.lambda = ph_en_to_lambda(eV_to_J(2.0e3));  /* Wavelength */
231
	image.molecule = load_molecule();
Thomas White's avatar
Thomas White committed
232

Thomas White's avatar
Thomas White committed
233
	#include "geometry-lcls.tmp"
234

235
236
	powder = calloc(image.width*image.height, sizeof(*powder));

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

240
241
	do {

Thomas White's avatar
Thomas White committed
242
		int na, nb, nc;
243
		double a, b, c, d;
Thomas White's avatar
Thomas White committed
244

245
246
247
248
249
250
		//na = 8*random()/RAND_MAX + 4;
		//nb = 8*random()/RAND_MAX + 4;
		//nc = 16*random()/RAND_MAX + 30;
		na = 8;
		nb = 8;
		nc = 16;
Thomas White's avatar
Thomas White committed
251

252
253
254
		/* Read quaternion from stdin */
		if ( config_randomquat ) {
			image.orientation = random_quaternion();
255
		} else {
256
			image.orientation = read_quaternion();
257
258
		}

Thomas White's avatar
Thomas White committed
259
260
261
262
		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
263
		if ( !quaternion_valid(image.orientation) ) {
264
			ERROR("Orientation modulus is not zero!\n");
265
266
267
268
269
270
			return 1;
		}

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

272
273
274
275
		cell_get_parameters(image.molecule->cell, &a, &b, &c, &d, &d, &d);
		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);

276
		if ( config_gpu ) {
277
278
279
280
281
			if ( gctx == NULL ) {
				gctx = setup_gpu(config_nosfac, &image,
				                 image.molecule);
			}
			get_diffraction_gpu(gctx, &image, na, nb, nc);
282
		} else {
283
284
			get_diffraction(&image, na, nb, nc, config_nosfac,
			                !config_nowater);
285
		}
Thomas White's avatar
Thomas White committed
286
287
288
289
		if ( image.molecule == NULL ) {
			ERROR("Couldn't open molecule.pdb\n");
			return 1;
		}
290
		if ( image.data == NULL ) {
291
292
293
294
			ERROR("Diffraction calculation failed.\n");
			goto skip;
		}

295
		record_image(&image, !config_nonoise);
Thomas White's avatar
Thomas White committed
296

Thomas White's avatar
Thomas White committed
297
		if ( config_nearbragg ) {
298
			output_intensities(&image, image.molecule->cell);
Thomas White's avatar
Thomas White committed
299
300
		}

301
302
303
304
305
306
307
308
		if ( config_powder ) {

			int x, y, w;

			w = image.width;

			for ( x=0; x<image.width; x++ ) {
			for ( y=0; y<image.height; y++ ) {
309
				powder[x+w*y] += (double)image.data[x+w*y];
310
311
312
313
			}
			}

			if ( !(ndone % 10) ) {
314
				hdf5_write("results/integr.h5", powder,
315
				           image.width, image.height,
316
				           H5T_NATIVE_DOUBLE);
317
318
319
			}
		}

320
321
322
323
324
325
		if ( !config_noimages ) {

			char filename[1024];

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

327
328
			/* Write the output file */
			hdf5_write(filename, image.data,
329
			           image.width, image.height, H5T_NATIVE_FLOAT);
330
331

		}
332

333
334
335
		/* Clean up */
		free(image.data);
		free(image.twotheta);
Thomas White's avatar
Thomas White committed
336

337
skip:
Thomas White's avatar
Thomas White committed
338
		ndone++;
339

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

342
	} while ( !done );
343

344
345
346
347
	if ( gctx != NULL ) {
		cleanup_gpu(gctx);
	}

348
349
350
351
352
	free(image.det.panels);
	free(powder);
	free(image.molecule->reflections);
	free(image.molecule);

353
	return 0;
354
}