pattern_sim.c 8.92 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
#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
84
85
86
87
"This square modulus of this value is take, and multiplied by the Bragg\n"
"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;
Thomas White's avatar
Thomas White committed
166

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

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

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

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

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

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

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

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

	}

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

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

229
230
231
232
233
234
235
236
237
238
239
	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;
	} else {
		intensities = read_reflections(intfile);
		free(intfile);
	}

Thomas White's avatar
Thomas White committed
240
	/* Define image parameters */
Thomas White's avatar
Thomas White committed
241
242
	image.width = 1024;
	image.height = 1024;
Thomas White's avatar
Thomas White committed
243
	image.lambda = ph_en_to_lambda(eV_to_J(1790.0));  /* Wavelength */
244
	cell = load_cell_from_pdb("molecule.pdb");
Thomas White's avatar
Thomas White committed
245

Thomas White's avatar
Thomas White committed
246
	#include "geometry-lcls.tmp"
247

248
249
	powder = calloc(image.width*image.height, sizeof(*powder));

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

253
254
	do {

Thomas White's avatar
Thomas White committed
255
		int na, nb, nc;
256
		double a, b, c, d;
Thomas White's avatar
Thomas White committed
257

258
259
260
		//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
261
262
263
		na = 24;
		nb = 24;
		nc = 40;
Thomas White's avatar
Thomas White committed
264

265
266
267
		/* Read quaternion from stdin */
		if ( config_randomquat ) {
			image.orientation = random_quaternion();
268
		} else {
269
			image.orientation = read_quaternion();
270
271
		}

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

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

285
		cell_get_parameters(cell, &a, &b, &c, &d, &d, &d);
286
287
288
		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);

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

304
		record_image(&image, !config_nonoise);
Thomas White's avatar
Thomas White committed
305

Thomas White's avatar
Thomas White committed
306
		if ( config_nearbragg ) {
307
			output_intensities(&image, cell);
Thomas White's avatar
Thomas White committed
308
309
		}

310
311
312
313
314
315
316
317
		if ( config_powder ) {

			int x, y, w;

			w = image.width;

			for ( x=0; x<image.width; x++ ) {
			for ( y=0; y<image.height; y++ ) {
318
				powder[x+w*y] += (double)image.data[x+w*y];
319
320
321
322
			}
			}

			if ( !(ndone % 10) ) {
323
				hdf5_write("results/integr.h5", powder,
324
				           image.width, image.height,
325
				           H5T_NATIVE_DOUBLE);
326
327
328
			}
		}

329
330
331
332
333
334
		if ( !config_noimages ) {

			char filename[1024];

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

336
337
			/* Write the output file */
			hdf5_write(filename, image.data,
338
			           image.width, image.height, H5T_NATIVE_FLOAT);
339
340

		}
341

342
343
344
		/* Clean up */
		free(image.data);
		free(image.twotheta);
Thomas White's avatar
Thomas White committed
345

346
skip:
Thomas White's avatar
Thomas White committed
347
		ndone++;
348

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

351
	} while ( !done );
352

353
354
355
356
	if ( gctx != NULL ) {
		cleanup_gpu(gctx);
	}

357
358
	free(image.det.panels);
	free(powder);
359
360
	free(cell);
	free(intensities);
361

362
	return 0;
363
}