pattern_sim.c 7.54 KB
Newer Older
1
2
3
4
5
/*
 * main.c
 *
 * (c) 2006-2009 Thomas White <thomas.white@desy.de>
 *
6
 * pattern_sim - Simulate diffraction patterns from small crystals
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 */


#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
20
#include <getopt.h>
21

22
#include "image.h"
Thomas White's avatar
Thomas White committed
23
#include "diffraction.h"
24
#include "cell.h"
25
26
#include "utils.h"
#include "hdf5-file.h"
Thomas White's avatar
Thomas White committed
27
#include "detector.h"
Thomas White's avatar
Thomas White committed
28
#include "intensities.h"
Thomas White's avatar
Thomas White committed
29
#include "sfac.h"
30
31


Thomas White's avatar
Thomas White committed
32
static void show_help(const char *s)
33
{
34
	printf("Syntax: %s [options]\n\n", s);
Thomas White's avatar
Thomas White committed
35
	printf(
Thomas White's avatar
Thomas White committed
36
"Simulate diffraction patterns from small crystals probed with femtosecond\n"
Thomas White's avatar
Thomas White committed
37
38
"pulses of X-rays from a free electron laser.\n"
"\n"
39
40
41
42
43
44
" -h, --help                Display this help message.\n"
"     --simulation-details  Show technical details of the simulation.\n"
"\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
45
" -r, --random-orientation  Use a randomly generated orientation\n"
46
"                            (a new orientation will be used for each image).\n"
Thomas White's avatar
Thomas White committed
47
48
49
50
51
"\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"
52
"     --no-water            Do not simulate water background.\n"
Thomas White's avatar
Thomas White committed
53
"     --no-noise            Do not calculate Poisson noise.\n"
Thomas White's avatar
Thomas White committed
54
55
56
"     --no-bloom            Do not calculate CCD bloom (intensities which are\n"
"                            above the recordable range will be clamped to\n"
"                            the maximum allowable value).\n"
57
);
Thomas White's avatar
Thomas White committed
58
59
60
}


61
static void show_details()
Thomas White's avatar
Thomas White committed
62
{
Thomas White's avatar
Thomas White committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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"
"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
91
"Phys Chem Chem Phys 2003 (5) 1981--1991.\n"
Thomas White's avatar
Thomas White committed
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
"\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"
"algorithm.\n"
"\n"
"Bloom of the CCD is included.  Any excess intensity in a particular pixel\n"
"is divided between the neighbouring pixels.  Diagonal neighbours receive\n"
"half the contribution of adjacent pixels.  This process is repeated for\n"
"every pixel until all pixels are below the saturation value.  Note that this\n"
"process is slow for very saturated images.\n");
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
137
138
}


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

	} while ( 1 );
143
144
145
146
147
}


int main(int argc, char *argv[])
{
148
	int c;
149
	struct image image;
Thomas White's avatar
Thomas White committed
150
	int config_simdetails = 0;
151
152
	int config_nearbragg = 0;
	int config_randomquat = 0;
153
	int config_noimages = 0;
154
	int config_nowater = 0;
Thomas White's avatar
Thomas White committed
155
	int config_nonoise = 0;
Thomas White's avatar
Thomas White committed
156
	int config_nobloom = 0;
157
158
159
	int number = 1;  /* Index for the current image */
	int n_images = 1;  /* Generate one image by default */
	int done = 0;
Thomas White's avatar
Thomas White committed
160

161
	/* Long options */
Thomas White's avatar
Thomas White committed
162
	const struct option longopts[] = {
163
164
165
166
167
		{"help",               0, NULL,               'h'},
		{"simulation-details", 0, &config_simdetails,  1},
		{"near-bragg",         0, &config_nearbragg,   1},
		{"random-orientation", 0, NULL,               'r'},
		{"number",             1, NULL,               'n'},
Thomas White's avatar
Thomas White committed
168
		{"no-images",          0, &config_noimages,    1},
169
		{"no-water",           0, &config_nowater,     1},
Thomas White's avatar
Thomas White committed
170
		{"no-noise",           0, &config_nonoise,     1},
Thomas White's avatar
Thomas White committed
171
		{"no-bloom",           0, &config_nobloom,     1},
172
		{0, 0, NULL, 0}
Thomas White's avatar
Thomas White committed
173
	};
174

175
176
	/* Short options */
	while ((c = getopt_long(argc, argv, "hrn:", longopts, NULL)) != -1) {
177

Thomas White's avatar
Thomas White committed
178
179
180
181
182
		switch (c) {
		case 'h' : {
			show_help(argv[0]);
			return 0;
		}
183

184
185
186
187
188
189
190
191
192
193
		case 'r' : {
			config_randomquat = 1;
			break;
		}

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

Thomas White's avatar
Thomas White committed
194
195
196
		case 0 : {
			break;
		}
197

Thomas White's avatar
Thomas White committed
198
199
200
		default : {
			return 1;
		}
201
202
203
204
		}

	}

Thomas White's avatar
Thomas White committed
205
	if ( config_simdetails ) {
206
		show_details();
Thomas White's avatar
Thomas White committed
207
208
209
		return 0;
	}

Thomas White's avatar
Thomas White committed
210
	/* Define image parameters */
Thomas White's avatar
Thomas White committed
211
212
	image.width = 1024;
	image.height = 1024;
Thomas White's avatar
Thomas White committed
213
	image.fmode = FORMULATION_CLEN;
Thomas White's avatar
Thomas White committed
214
215
	image.x_centre = 512.5;
	image.y_centre = 512.5;
Thomas White's avatar
Thomas White committed
216
	image.camera_len = 0.05;  /* 5 cm (front CCD can move from 5cm-20cm) */
Thomas White's avatar
Thomas White committed
217
	image.resolution = 13333.3; /* 75 micron pixel size */
Thomas White's avatar
Thomas White committed
218
219
220
221
222
	image.xray_energy = eV_to_J(2.0e3); /* 2 keV energy */
	image.lambda = ph_en_to_lambda(image.xray_energy);  /* Wavelength */
	image.molecule = NULL;

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

225
226
	do {

Thomas White's avatar
Thomas White committed
227
228
		int na, nb, nc;

Thomas White's avatar
Thomas White committed
229
230
231
		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
232

233
234
235
		/* Read quaternion from stdin */
		if ( config_randomquat ) {
			image.orientation = random_quaternion();
236
		} else {
237
			image.orientation = read_quaternion();
238
239
		}

Thomas White's avatar
Thomas White committed
240
241
242
243
		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
244
		if ( !quaternion_valid(image.orientation) ) {
245
			ERROR("Orientation modulus is not zero!\n");
246
247
248
249
250
251
252
253
254
			return 1;
		}

		/* Ensure no residual information */
		image.qvecs = NULL;
		image.sfacs = NULL;
		image.data = NULL;
		image.twotheta = NULL;
		image.hdr = NULL;
255

Thomas White's avatar
Thomas White committed
256
		get_diffraction(&image, na, nb, nc);
Thomas White's avatar
Thomas White committed
257
258
		record_image(&image, !config_nowater, !config_nonoise,
		             !config_nobloom);
Thomas White's avatar
Thomas White committed
259

Thomas White's avatar
Thomas White committed
260
261
262
263
		if ( config_nearbragg ) {
			output_intensities(&image);
		}

264
265
266
267
268
269
		if ( !config_noimages ) {

			char filename[1024];

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

271
272
273
274
275
			/* Write the output file */
			hdf5_write(filename, image.data,
			           image.width, image.height);

		}
276

277
278
279
280
281
282
		/* Clean up */
		free(image.data);
		free(image.qvecs);
		free(image.hdr);
		free(image.sfacs);
		free(image.twotheta);
Thomas White's avatar
Thomas White committed
283

284
		if ( n_images && (number >= n_images) ) done = 1;
Thomas White's avatar
Thomas White committed
285

286
	} while ( !done );
287
288

	return 0;
289
}