pattern_sim.c 6.21 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"
29
30


Thomas White's avatar
Thomas White committed
31
static void show_help(const char *s)
32
{
Thomas White's avatar
Thomas White committed
33
	printf("Syntax: %s\n\n", s);
Thomas White's avatar
Thomas White committed
34
35
36
37
38
39
40
41
42
43
	printf(
"Simulate diffraction patterns from small crystals probed with femosecond\n"
"pulses of X-rays from a free electron laser.\n"
"\n"
" -h, --help                Display this help message\n"
" --simulation-details      Show technical details of the simulation\n"
" --near-bragg              Output h,k,l,I near Bragg conditions\n"
" -r, --random-orientation  Use a randomly generated orientation\n"
"                            (a new orientation will be used for each image)\n"
" -n, --number=<N>          Generate N images.  Default 1\n");
Thomas White's avatar
Thomas White committed
44
45
46
}


47
static void show_details()
Thomas White's avatar
Thomas White committed
48
{
Thomas White's avatar
Thomas White committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
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"
"Phys Chem Chem Phys 20033 (5) 1981--1991.\n"
"\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");
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
}


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 {
125
			ERROR("Invalid rotation '%s'\n", line);
126
127
128
		}

	} while ( 1 );
129
130
131
132
133
}


int main(int argc, char *argv[])
{
134
	int c;
135
	struct image image;
136
	char filename[1024];
Thomas White's avatar
Thomas White committed
137
	int config_simdetails = 0;
138
139
140
141
142
	int config_nearbragg = 0;
	int config_randomquat = 0;
	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
143

144
	/* Long options */
Thomas White's avatar
Thomas White committed
145
	const struct option longopts[] = {
146
147
148
149
150
151
		{"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'},
		{0, 0, NULL, 0}
Thomas White's avatar
Thomas White committed
152
	};
153

154
155
	/* Short options */
	while ((c = getopt_long(argc, argv, "hrn:", longopts, NULL)) != -1) {
156

Thomas White's avatar
Thomas White committed
157
158
159
160
161
		switch (c) {
		case 'h' : {
			show_help(argv[0]);
			return 0;
		}
162

163
164
165
166
167
168
169
170
171
172
		case 'r' : {
			config_randomquat = 1;
			break;
		}

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

Thomas White's avatar
Thomas White committed
173
174
175
		case 0 : {
			break;
		}
176

Thomas White's avatar
Thomas White committed
177
178
179
		default : {
			return 1;
		}
180
181
182
183
		}

	}

Thomas White's avatar
Thomas White committed
184
	if ( config_simdetails ) {
185
		show_details();
Thomas White's avatar
Thomas White committed
186
187
188
		return 0;
	}

Thomas White's avatar
Thomas White committed
189
	/* Define image parameters */
Thomas White's avatar
Thomas White committed
190
191
	image.width = 1024;
	image.height = 1024;
Thomas White's avatar
Thomas White committed
192
	image.fmode = FORMULATION_CLEN;
Thomas White's avatar
Thomas White committed
193
194
	image.x_centre = 512.5;
	image.y_centre = 512.5;
Thomas White's avatar
Thomas White committed
195
	image.camera_len = 0.10;  /* 10 cm (front CCD can move from 5cm-20cm) */
Thomas White's avatar
Thomas White committed
196
	image.resolution = 13333.3; /* 75 micron pixel size */
Thomas White's avatar
Thomas White committed
197
198
199
200
201
	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 */
202
	STATUS("Wavelength is %f nm\n", image.lambda/1.0e-9);
Thomas White's avatar
Thomas White committed
203

204
205
	do {

206
207
208
		/* Read quaternion from stdin */
		if ( config_randomquat ) {
			image.orientation = random_quaternion();
209
		} else {
210
			image.orientation = read_quaternion();
211
212
		}

Thomas White's avatar
D'oh    
Thomas White committed
213
		if ( !quaternion_valid(image.orientation) ) {
214
			ERROR("Orientation modulus is not zero!\n");
215
216
217
218
219
220
221
222
223
			return 1;
		}

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

225
226
		get_diffraction(&image);
		record_image(&image);
Thomas White's avatar
Thomas White committed
227

Thomas White's avatar
Thomas White committed
228
229
230
231
		if ( config_nearbragg ) {
			output_intensities(&image);
		}

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

235
236
		/* Write the output file */
		hdf5_write(filename, image.data, image.width, image.height);
237

238
239
240
241
242
243
		/* Clean up */
		free(image.data);
		free(image.qvecs);
		free(image.hdr);
		free(image.sfacs);
		free(image.twotheta);
Thomas White's avatar
Thomas White committed
244

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

247
	} while ( !done );
248
249

	return 0;
250
}