partial_sim.c 13.3 KB
Newer Older
1
2
3
4
5
/*
 * partial_sim.c
 *
 * Generate partials for testing scaling
 *
6
7
8
9
 * Copyright © 2012 Deutsches Elektronen-Synchrotron DESY,
 *                  a research centre of the Helmholtz Association.
 *
 * Authors:
10
 *   2011-2012 Thomas White <taw@physics.org>
11
 *
Thomas White's avatar
Thomas White committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 * This file is part of CrystFEL.
 *
 * CrystFEL is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * CrystFEL is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with CrystFEL.  If not, see <http://www.gnu.org/licenses/>.
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 *
 */


#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 <assert.h>
41
#include <pthread.h>
42

43
44
45
46
47
48
49
50
51
#include "image.h"
#include "utils.h"
#include "reflist-utils.h"
#include "symmetry.h"
#include "beam-parameters.h"
#include "geometry.h"
#include "stream.h"
#include "thread-pool.h"
#include "cell-utils.h"
52

53
54
55
/* Number of bins for partiality graph */
#define NBINS 50

56

57
static void mess_up_cell(UnitCell *cell, double cnoise)
58
59
60
61
62
{
	double ax, ay, az;
	double bx, by, bz;
	double cx, cy, cz;

Thomas White's avatar
Thomas White committed
63
64
	//STATUS("Real:\n");
	//cell_print(cell);
Thomas White's avatar
Thomas White committed
65

66
	cell_get_reciprocal(cell, &ax, &ay, &az, &bx, &by, &bz, &cx, &cy, &cz);
67
68
69
70
71
72
73
74
75
	ax = flat_noise(ax, cnoise*fabs(ax)/100.0);
	ay = flat_noise(ay, cnoise*fabs(ay)/100.0);
	az = flat_noise(az, cnoise*fabs(az)/100.0);
	bx = flat_noise(bx, cnoise*fabs(bx)/100.0);
	by = flat_noise(by, cnoise*fabs(by)/100.0);
	bz = flat_noise(bz, cnoise*fabs(bz)/100.0);
	cx = flat_noise(cx, cnoise*fabs(cx)/100.0);
	cy = flat_noise(cy, cnoise*fabs(cy)/100.0);
	cz = flat_noise(cz, cnoise*fabs(cz)/100.0);
76
	cell_set_reciprocal(cell, ax, ay, az, bx, by, bz, cx, cy, cz);
Thomas White's avatar
Thomas White committed
77

Thomas White's avatar
Thomas White committed
78
79
	//STATUS("Changed:\n");
	//cell_print(cell);
80
81
}

82

83
84
/* For each reflection in "partial", fill in what the intensity would be
 * according to "full" */
85
static void calculate_partials(RefList *partial, double osf,
Thomas White's avatar
Thomas White committed
86
                               RefList *full, const SymOpList *sym,
87
                               int random_intensities,
88
89
                               pthread_mutex_t *full_lock,
                               unsigned long int *n_ref, double *p_hist,
90
                               double *p_max, double max_q, UnitCell *cell)
91
92
93
94
95
96
{
	Reflection *refl;
	RefListIterator *iter;

	for ( refl = first_refl(partial, &iter);
	      refl != NULL;
Thomas White's avatar
Thomas White committed
97
98
	      refl = next_refl(refl, iter) )
	{
99
100
		signed int h, k, l;
		Reflection *rfull;
Thomas White's avatar
Thomas White committed
101
		double p, Ip, If;
102
		int bin;
103
104

		get_indices(refl, &h, &k, &l);
Thomas White's avatar
Thomas White committed
105
		get_asymm(sym, h, k, l, &h, &k, &l);
106
107
		p = get_partiality(refl);

108
		pthread_mutex_lock(full_lock);
109
		rfull = find_refl(full, h, k, l);
110
111
		pthread_mutex_unlock(full_lock);

112
		if ( rfull == NULL ) {
113
			if ( random_intensities ) {
114
115
116
117
118
119

				/* The full reflection is immutable (in this
				 * program) once created, but creating it must
				 * be an atomic operation.  So do the whole
				 * thing under lock. */
				pthread_mutex_lock(full_lock);
120
121
				rfull = add_refl(full, h, k, l);
				If = fabs(gaussian_noise(0.0, 1000.0));
122
				set_intensity(rfull, If);
123
				set_redundancy(rfull, 1);
124
125
				pthread_mutex_unlock(full_lock);

126
127
128
129
			} else {
				set_redundancy(refl, 0);
				If = 0.0;
			}
130
131
		} else {
			If = get_intensity(rfull);
132
			if ( random_intensities ) {
133
				lock_reflection(rfull);
134
135
				int red = get_redundancy(rfull);
				set_redundancy(rfull, red+1);
136
				unlock_reflection(rfull);
137
			}
138
		}
139
140

		Ip = osf * p * If;
141

142
143
144
145
		bin = NBINS*2.0*resolution(cell, h, k, l) / max_q;
		if ( (bin < NBINS) && (bin>=0) ) {
			p_hist[bin] += p;
			n_ref[bin]++;
146
			if ( p > p_max[bin] ) p_max[bin] = p;
Thomas White's avatar
Thomas White committed
147
148
149
		} else {
			STATUS("Reflection out of histogram range: %e %i %f\n",
			       resolution(cell, h, k, l), bin,  p);
150
151
		}

152
		Ip = gaussian_noise(Ip, 100.0);
153

154
		set_intensity(refl, Ip);
155
		set_esd_intensity(refl, 100.0);
156
157
158
159
160
161
162
163
164
165
166
167
168
	}
}


static void show_help(const char *s)
{
	printf("Syntax: %s [options]\n\n", s);
	printf(
"Generate a stream containing partials from a reflection list.\n"
"\n"
" -h, --help              Display this help message.\n"
"\n"
"You need to provide the following basic options:\n"
169
170
171
172
173
174
" -i, --input=<file>       Read reflections from <file>.\n"
"                           Default: generate random ones instead (see -r).\n"
" -o, --output=<file>      Write partials in stream format to <file>.\n"
" -g. --geometry=<file>    Get detector geometry from file.\n"
" -b, --beam=<file>        Get beam parameters from file\n"
" -p, --pdb=<file>         PDB file from which to get the unit cell.\n"
175
"\n"
176
177
178
" -y, --symmetry=<sym>     Symmetry of the input reflection list.\n"
" -n <n>                   Simulate <n> patterns.  Default: 2.\n"
" -r, --save-random=<file> Save randomly generated intensities to file.\n"
179
180
181
182
" -c, --cnoise=<val>       Add random noise, with a flat distribution, to the\n"
"                          reciprocal lattice vector components given in the\n"
"                          stream, with maximum error +/- <val> percent.\n"
"\n"
183
184
185
186
);
}


187
188
189
190
191
192
struct queue_args
{
	RefList *full;
	pthread_mutex_t full_lock;

	int n_done;
193
	int n_started;
194
195
196
197
198
	int n_to_do;

	SymOpList *sym;
	int random_intensities;
	UnitCell *cell;
199
	double cnoise;
200
201

	struct image *template_image;
202
203
204
205
206
	double max_q;

	/* The overall histogram */
	double p_hist[NBINS];
	unsigned long int n_ref[NBINS];
207
	double p_max[NBINS];
208
209
210
211
212
213
214
215
216

	FILE *stream;
};


struct worker_args
{
	struct queue_args *qargs;
	struct image image;
217
218
219
220

	/* Histogram for this image */
	double p_hist[NBINS];
	unsigned long int n_ref[NBINS];
221
	double p_max[NBINS];
222
223
224
225
226
227
228
229
};


static void *create_job(void *vqargs)
{
	struct worker_args *wargs;
	struct queue_args *qargs = vqargs;

230
231
232
	/* All done already? */
	if ( qargs->n_started == qargs->n_to_do ) return NULL;

233
234
235
236
237
	wargs = malloc(sizeof(struct worker_args));

	wargs->qargs = qargs;
	wargs->image = *qargs->template_image;

238
239
	qargs->n_started++;

240
241
242
243
244
245
246
247
248
249
	return wargs;
}


static void run_job(void *vwargs, int cookie)
{
	double osf;
	struct quaternion orientation;
	struct worker_args *wargs = vwargs;
	struct queue_args *qargs = wargs->qargs;
250
	int i;
251
252
253
254
255
256
257
258
259
260

	osf = gaussian_noise(1.0, 0.3);

	/* Set up a random orientation */
	orientation = random_quaternion();
	wargs->image.indexed_cell = cell_rotate(qargs->cell, orientation);

	snprintf(wargs->image.filename, 255, "dummy.h5");
	wargs->image.reflections = find_intersections(&wargs->image,
	                                       wargs->image.indexed_cell);
261
262
263
264

	for ( i=0; i<NBINS; i++ ) {
		wargs->n_ref[i] = 0;
		wargs->p_hist[i] = 0.0;
265
		wargs->p_max[i] = 0.0;
266
267
	}

268
269
	calculate_partials(wargs->image.reflections, osf, qargs->full,
	                   qargs->sym, qargs->random_intensities,
270
	                   &qargs->full_lock,
271
272
	                   wargs->n_ref, wargs->p_hist, wargs->p_max,
	                   qargs->max_q, wargs->image.indexed_cell);
273
274

	/* Give a slightly incorrect cell in the stream */
275
	mess_up_cell(wargs->image.indexed_cell, qargs->cnoise);
276
277
278
279
280
281
282
}


static void finalise_job(void *vqargs, void *vwargs)
{
	struct worker_args *wargs = vwargs;
	struct queue_args *qargs = vqargs;
283
	int i;
284

285
	write_chunk(qargs->stream, &wargs->image, NULL, STREAM_INTEGRATED);
286

287
288
289
	for ( i=0; i<NBINS; i++ ) {
		qargs->n_ref[i] += wargs->n_ref[i];
		qargs->p_hist[i] += wargs->p_hist[i];
290
291
292
		if ( wargs->p_max[i] > qargs->p_max[i] ) {
			qargs->p_max[i] = wargs->p_max[i];
		}
293
294
	}

295
296
	qargs->n_done++;
	progress_bar(qargs->n_done, qargs->n_to_do, "Simulating");
297
298
299
300

	reflist_free(wargs->image.reflections);
	cell_free(wargs->image.indexed_cell);
	free(wargs);
301
302
303
}


304
305
306
307
308
309
310
311
312
313
int main(int argc, char *argv[])
{
	int c;
	char *input_file = NULL;
	char *output_file = NULL;
	char *beamfile = NULL;
	char *geomfile = NULL;
	char *cellfile = NULL;
	struct detector *det = NULL;
	struct beam_params *beam = NULL;
314
	RefList *full = NULL;
Thomas White's avatar
Thomas White committed
315
316
	char *sym_str = NULL;
	SymOpList *sym;
317
318
	UnitCell *cell = NULL;
	FILE *ofh;
319
	int n = 2;
320
	int random_intensities = 0;
321
	char *save_file = NULL;
322
323
324
	struct queue_args qargs;
	struct image image;
	int n_threads = 1;
325
326
	double cnoise = 0.0;
	char *rval;
327
328
329
	int i;
	FILE *fh;
	char *phist_file = NULL;
330
331
332
333
334
335
336
337
338
339

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
		{"output",             1, NULL,               'o'},
		{"input",              1, NULL,               'i'},
		{"beam",               1, NULL,               'b'},
		{"pdb",                1, NULL,               'p'},
		{"geometry",           1, NULL,               'g'},
		{"symmetry",           1, NULL,               'y'},
340
		{"save-random",        1, NULL,               'r'},
341
		{"pgraph",             1, NULL,                2},
342
		{"cnoise",             1, NULL,               'c'},
343
344
345
346
		{0, 0, NULL, 0}
	};

	/* Short options */
347
	while ((c = getopt_long(argc, argv, "hi:o:b:p:g:y:n:r:j:c:",
Thomas White's avatar
Thomas White committed
348
349
	                        longopts, NULL)) != -1)
	{
350
		switch (c) {
Thomas White's avatar
Thomas White committed
351
352

			case 'h' :
353
354
355
			show_help(argv[0]);
			return 0;

Thomas White's avatar
Thomas White committed
356
			case 'o' :
357
358
359
			output_file = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
360
			case 'i' :
361
362
363
			input_file = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
364
			case 'b' :
365
366
367
			beamfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
368
			case 'p' :
369
370
371
			cellfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
372
			case 'g' :
373
374
375
			geomfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
376
			case 'y' :
Thomas White's avatar
Thomas White committed
377
			sym_str = strdup(optarg);
378
379
			break;

Thomas White's avatar
Thomas White committed
380
			case 'n' :
381
382
383
			n = atoi(optarg);
			break;

Thomas White's avatar
Thomas White committed
384
			case 'r' :
385
386
387
			save_file = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
388
			case 'j' :
389
390
391
			n_threads = atoi(optarg);
			break;

Thomas White's avatar
Thomas White committed
392
			case 'c' :
393
394
395
396
397
398
399
			cnoise = strtod(optarg, &rval);
			if ( *rval != '\0' ) {
				ERROR("Invalid cell noise value.\n");
				return 1;
			}
			break;

Thomas White's avatar
Thomas White committed
400
			case 2 :
401
402
403
			phist_file = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
404
			case 0 :
405
406
			break;

407
408
409
			case '?' :
			break;

Thomas White's avatar
Thomas White committed
410
			default :
411
412
			ERROR("Unhandled option '%c'\n", c);
			break;
Thomas White's avatar
Thomas White committed
413

414
415
416
		}
	}

417
418
419
420
421
	if ( n_threads < 1 ) {
		ERROR("Invalid number of threads.\n");
		return 1;
	}

422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
	/* Load beam */
	if ( beamfile == NULL ) {
		ERROR("You need to provide a beam parameters file.\n");
		return 1;
	}
	beam = get_beam_parameters(beamfile);
	if ( beam == NULL ) {
		ERROR("Failed to load beam parameters from '%s'\n", beamfile);
		return 1;
	}
	free(beamfile);

	/* Load cell */
	if ( cellfile == NULL ) {
		ERROR("You need to give a PDB file with the unit cell.\n");
		return 1;
	}
	cell = load_cell_from_pdb(cellfile);
	if ( cell == NULL ) {
		ERROR("Failed to get cell from '%s'\n", cellfile);
		return 1;
	}
	free(cellfile);

Thomas White's avatar
Thomas White committed
446
447
448
449
450
451
	if ( !cell_is_sensible(cell) ) {
		ERROR("Invalid unit cell parameters:\n");
		cell_print(cell);
		return 1;
	}

452
453
454
455
456
457
	/* Load geometry */
	if ( geomfile == NULL ) {
		ERROR("You need to give a geometry file.\n");
		return 1;
	}
	det = get_detector_geometry(geomfile);
458
	if ( det == NULL ) {
459
460
461
462
463
		ERROR("Failed to read geometry from '%s'\n", geomfile);
		return 1;
	}
	free(geomfile);

Thomas White's avatar
Thomas White committed
464
465
466
467
	if ( sym_str == NULL ) sym_str = strdup("1");
	sym = get_pointgroup(sym_str);
	free(sym_str);

468
469
	if ( save_file == NULL ) save_file = strdup("partial_sim.hkl");

470
	/* Load (full) reflections */
471
472
473
474
475
476
477
478
479
480
481
	if ( input_file != NULL ) {

		full = read_reflections(input_file);
		if ( full == NULL ) {
			ERROR("Failed to read reflections from '%s'\n",
			      input_file);
			return 1;
		}
		free(input_file);
		if ( check_list_symmetry(full, sym) ) {
			ERROR("The input reflection list does not appear to"
Thomas White's avatar
Thomas White committed
482
			      " have symmetry %s\n", symmetry_name(sym));
483
484
485
486
487
			return 1;
		}

	} else {
		random_intensities = 1;
488
489
	}

490
491
492
493
494
	if ( n < 1 ) {
		ERROR("Number of patterns must be at least 1.\n");
		return 1;
	}

495
	if ( output_file == NULL ) {
Thomas White's avatar
Thomas White committed
496
		ERROR("You must give a filename for the output.\n");
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
		return 1;
	}
	ofh = fopen(output_file, "w");
	if ( ofh == NULL ) {
		ERROR("Couldn't open output file '%s'\n", output_file);
		return 1;
	}
	free(output_file);
	write_stream_header(ofh, argc, argv);

	image.det = det;
	image.width = det->max_fs;
	image.height = det->max_ss;

	image.lambda = ph_en_to_lambda(eV_to_J(beam->photon_energy));
	image.div = beam->divergence;
	image.bw = beam->bandwidth;
514
	image.profile_radius = beam->profile_radius;
515
	image.filename = malloc(256);
516
	image.copyme = NULL;
517

518
519
520
521
	if ( random_intensities ) {
		full = reflist_new();
	}

522
523
524
525
	qargs.full = full;
	pthread_mutex_init(&qargs.full_lock, NULL);
	qargs.n_to_do = n;
	qargs.n_done = 0;
526
	qargs.n_started = 0;
527
528
529
530
531
	qargs.sym = sym;
	qargs.random_intensities = random_intensities;
	qargs.cell = cell;
	qargs.template_image = &image;
	qargs.stream = ofh;
532
	qargs.cnoise = cnoise;
533
534
535
536
537
	qargs.max_q = largest_q(&image);

	for ( i=0; i<NBINS; i++ ) {
		qargs.n_ref[i] = 0;
		qargs.p_hist[i] = 0.0;
538
		qargs.p_max[i] = 0.0;
539
	}
540
541

	run_threads(n_threads, run_job, create_job, finalise_job,
542
	            &qargs, n, 0, 0, 0);
543

544
	if ( random_intensities ) {
545
		STATUS("Writing full intensities to %s\n", save_file);
546
		write_reflist(save_file, full);
547
548
	}

549
	if ( phist_file != NULL ) {
Thomas White's avatar
Thomas White committed
550

551
552
		fh = fopen(phist_file, "w");

Thomas White's avatar
Thomas White committed
553
		if ( fh != NULL ) {
554

Thomas White's avatar
Thomas White committed
555
			for ( i=0; i<NBINS; i++ ) {
556

Thomas White's avatar
Thomas White committed
557
				double rcen;
558

Thomas White's avatar
Thomas White committed
559
560
561
562
563
564
565
566
				rcen = i/(double)NBINS*qargs.max_q
					  + qargs.max_q/(2.0*NBINS);
				fprintf(fh, "%.2f %7li %.3f %.3f\n", rcen/1.0e9,
					qargs.n_ref[i],
					qargs.p_hist[i]/qargs.n_ref[i],
					qargs.p_max[i]);

			}
567

Thomas White's avatar
Thomas White committed
568
569
570
571
572
573
			fclose(fh);

		} else {
			ERROR("Failed to open file '%s' for writing.\n",
			      phist_file);
		}
574
575
576

	}

577
578
579
580
	fclose(ofh);
	cell_free(cell);
	free_detector_geometry(det);
	free(beam);
Thomas White's avatar
Thomas White committed
581
	free_symoplist(sym);
582
	reflist_free(full);
583
	free(image.filename);
584
585
586

	return 0;
}