1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
|
/*
* pattern_sim.c
*
* Simulate diffraction patterns from small crystals
*
* (c) 2006-2010 Thomas White <taw@physics.org>
*
* Part of CrystFEL - crystallography with a FEL
*
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <getopt.h>
#include "image.h"
#include "diffraction.h"
#include "diffraction-gpu.h"
#include "cell.h"
#include "utils.h"
#include "hdf5-file.h"
#include "detector.h"
#include "peaks.h"
#include "sfac.h"
#include "reflections.h"
#include "parameters-lcls.tmp"
static void show_help(const char *s)
{
printf("Syntax: %s [options]\n\n", s);
printf(
"Simulate diffraction patterns from small crystals probed with femtosecond\n"
"pulses of X-rays from a free electron laser.\n"
"\n"
" -h, --help Display this help message.\n"
" -p, --pdb=<file> PDB file from which to get the unit cell.\n"
" (The actual Bragg intensities come from the\n"
" intensities file)\n"
" --simulation-details Show technical details of the simulation.\n"
" --gpu Use the GPU to speed up the calculation.\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"
" -o, --output=<filename> Output HDF5 filename. Default: sim.h5.\n"
" If you choose to simulate more than one pattern,\n"
" the filename given will be postfixed with a\n"
" hyphen, the image number and '.h5'. In this\n"
" case, the default value is 'sim', such that the\n"
" files produced are sim-1.h5, sim-2.h5 and so on.\n"
" -r, --random-orientation Use a randomly generated orientation\n"
" (a new orientation will be used for each image).\n"
" --powder Write a summed pattern of all images simulated by\n"
" this invocation to results/integr.h5.\n"
" -i, --intensities=<file> Specify file containing reflection intensities\n"
" (and phases) to use.\n"
" -g, --gradients=<method> Use <method> for the calculation of shape\n"
" transform intensities. Choose from:\n"
" mosaic : Take the intensity of the nearest\n"
" Bragg position. This is the\n"
" fastest method and the only one\n"
" supported on the GPU.\n"
" interpolate : Interpolate trilinearly between\n"
" six adjacent Bragg intensities.\n"
" This method has intermediate\n"
" accuracy.\n"
" phased : As 'interpolate', but take phase\n"
" values into account. This is the\n"
" most accurate method, but the\n"
" slowest.\n"
"\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"
" --no-water Do not simulate water background.\n"
" --no-noise Do not calculate Poisson noise.\n"
);
}
static void show_details()
{
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 faceted on the\n"
"(001), (010) and (100) planes:\n"
"\n"
"I_latt(q) = sin^2(pi*na*q.a)/sin^2(pi*q.a)\n"
" * sin^2(pi*nb*q.b)/sin^2(pi*q.b)\n"
" * sin^2(pi*nc*q.c)/sin^2(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 is multiplied by a model of the underlying molecular transform, I_mol(q).\n"
"This can be approximated to varying levels of accuracy by the methods given by\n"
"the '--gradients' option.\n"
"\n"
"Intensity from water is added according to the first term of equation 5\n"
"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"
"\n"
"Expected intensities at the CCD are then calculated using:\n"
"\n"
"I(q) = I0 * r^2 * I_latt(q) * I_mol(q) * 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"
"Polarisation is not currently included in pattern_sim, although it is included\n"
"in the analysis of Bragg peaks by 'indexamajig'.\n"
"\n"
"Poisson counts are generated from the expected intensities using Knuth's\n"
"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"
);
}
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 {
ERROR("Invalid rotation '%s'\n", line);
}
} while ( 1 );
}
int main(int argc, char *argv[])
{
int c;
struct image image;
struct gpu_context *gctx = NULL;
double *powder;
char *intfile = NULL;
double *intensities;
double *phases;
int config_simdetails = 0;
int config_nearbragg = 0;
int config_randomquat = 0;
int config_noimages = 0;
int config_nowater = 0;
int config_nonoise = 0;
int config_nosfac = 0;
int config_gpu = 0;
int config_powder = 0;
char *filename = NULL;
char *grad_str = NULL;
char *outfile = NULL;
GradientMethod grad;
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 */
int done = 0;
UnitCell *cell;
unsigned int *counts;
/* Long options */
const struct option longopts[] = {
{"help", 0, NULL, 'h'},
{"simulation-details", 0, &config_simdetails, 1},
{"gpu", 0, &config_gpu, 1},
{"near-bragg", 0, &config_nearbragg, 1},
{"random-orientation", 0, NULL, 'r'},
{"number", 1, NULL, 'n'},
{"no-images", 0, &config_noimages, 1},
{"no-water", 0, &config_nowater, 1},
{"no-noise", 0, &config_nonoise, 1},
{"intensities", 1, NULL, 'i'},
{"powder", 0, &config_powder, 1},
{"gradients", 1, NULL, 'g'},
{"pdb", 1, NULL, 'p'},
{"output", 1, NULL, 'o'},
{0, 0, NULL, 0}
};
/* Short options */
while ((c = getopt_long(argc, argv, "hrn:i:g:p:o:", longopts, NULL)) != -1) {
switch (c) {
case 'h' : {
show_help(argv[0]);
return 0;
}
case 'r' : {
config_randomquat = 1;
break;
}
case 'n' : {
n_images = atoi(optarg);
break;
}
case 'i' : {
intfile = strdup(optarg);
break;
}
case 'g' : {
grad_str = strdup(optarg);
break;
}
case 'p' : {
filename = strdup(optarg);
break;
}
case 'o' : {
outfile = strdup(optarg);
break;
}
case 0 : {
break;
}
default : {
return 1;
}
}
}
if ( filename == NULL ) {
filename = strdup("molecule.pdb");
}
if ( outfile == NULL ) {
if ( n_images == 1 ) {
outfile = strdup("sim.h5");
} else {
outfile = strdup("sim");
}
}
if ( config_simdetails ) {
show_details();
return 0;
}
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;
}
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;
counts = NULL;
phases = NULL;
} else {
counts = new_list_count();
phases = new_list_phase();
intensities = read_reflections(intfile, counts, phases);
free(intfile);
}
if ( grad_str == NULL ) {
STATUS("You didn't specify a gradient calculation method, so"
" I'm using the 'mosaic' method, which is fastest.\n");
grad = GRADIENT_MOSAIC;
} else if ( strcmp(grad_str, "mosaic") == 0 ) {
grad = GRADIENT_MOSAIC;
} else if ( strcmp(grad_str, "interpolate") == 0) {
grad = GRADIENT_INTERPOLATE;
} else if ( strcmp(grad_str, "phased") == 0) {
grad = GRADIENT_PHASED;
} else {
ERROR("Unrecognised gradient method '%s'\n", grad_str);
return 1;
}
free(grad_str);
if ( config_gpu && (grad != GRADIENT_MOSAIC) ) {
ERROR("Only the mosaic method can be used for gradients when"
"calculating on the GPU.\n");
return 1;
}
/* Define image parameters */
image.width = 1024;
image.height = 1024;
image.lambda = ph_en_to_lambda(eV_to_J(PHOTON_ENERGY)); /* Wavelength */
cell = load_cell_from_pdb(filename);
if ( cell == NULL ) {
exit(1);
}
image.filename = NULL;
image.features = NULL;
image.flags = NULL;
image.f0 = 1.0;
image.f0_available = 1;
#include "geometry-lcls.tmp"
powder = calloc(image.width*image.height, sizeof(*powder));
/* Splurge a few useful numbers */
STATUS("Wavelength is %f nm\n", image.lambda/1.0e-9);
do {
int na, nb, nc;
double a, b, c, d;
//na = 8*random()/RAND_MAX + 4;
//nb = 8*random()/RAND_MAX + 4;
//nc = 16*random()/RAND_MAX + 30;
na = 24;
nb = 24;
nc = 40;
/* Read quaternion from stdin */
if ( config_randomquat ) {
image.orientation = random_quaternion();
} else {
image.orientation = read_quaternion();
}
STATUS("Orientation is %5.3f %5.3f %5.3f %5.3f\n",
image.orientation.w, image.orientation.x,
image.orientation.y, image.orientation.z);
if ( !quaternion_valid(image.orientation) ) {
ERROR("Orientation modulus is not zero!\n");
return 1;
}
/* Ensure no residual information */
image.data = NULL;
image.twotheta = NULL;
cell_get_parameters(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);
if ( config_gpu ) {
if ( gctx == NULL ) {
gctx = setup_gpu(config_nosfac, &image,
intensities, counts);
}
get_diffraction_gpu(gctx, &image, na, nb, nc, cell);
} else {
get_diffraction(&image, na, nb, nc, intensities, counts,
phases, cell, !config_nowater, grad);
}
if ( image.data == NULL ) {
ERROR("Diffraction calculation failed.\n");
goto skip;
}
record_image(&image, !config_nonoise);
if ( config_nearbragg ) {
find_projected_peaks(&image, cell);
output_intensities(&image, cell, NULL, 1);
}
if ( config_powder ) {
int x, y, w;
w = image.width;
for ( x=0; x<image.width; x++ ) {
for ( y=0; y<image.height; y++ ) {
powder[x+w*y] += (double)image.data[x+w*y];
}
}
if ( !(ndone % 10) ) {
hdf5_write("results/integr.h5", powder,
image.width, image.height,
H5T_NATIVE_DOUBLE);
}
}
if ( !config_noimages ) {
char filename[1024];
if ( n_images != 1 ) {
snprintf(filename, 1023, "%s-%i.h5",
outfile, number);
} else {
strncpy(filename, outfile, 1023);
}
number++;
/* Write the output file */
hdf5_write(filename, image.data,
image.width, image.height, H5T_NATIVE_FLOAT);
}
/* Clean up */
free(image.data);
free(image.twotheta);
skip:
ndone++;
if ( n_images && (ndone >= n_images) ) done = 1;
} while ( !done );
if ( gctx != NULL ) {
cleanup_gpu(gctx);
}
free(image.det.panels);
free(powder);
free(cell);
free(intensities);
return 0;
}
|