process_hkl.c 15.5 KB
Newer Older
1
2
3
4
5
/*
 * process_hkl.c
 *
 * Assemble and process FEL Bragg intensities
 *
Thomas White's avatar
Thomas White committed
6
7
8
 * Copyright © 2012 Thomas White <taw@physics.org>
 * Copyright © 2012 Andrew Martin <andrew.martin@desy.de>
 * Copyright © 2012 Lorenzo Galli <lorenzo.galli@desy.de>
9
 *
Thomas White's avatar
Thomas White committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 * 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/>.
24
25
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 "utils.h"
#include "statistics.h"
41
#include "reflist-utils.h"
42
#include "symmetry.h"
43
#include "stream.h"
44
#include "beam-parameters.h"
45
46
#include "reflist.h"
#include "image.h"
47
48
49
50
51


static void show_help(const char *s)
{
	printf("Syntax: %s [options]\n\n", s);
Thomas White's avatar
Thomas White committed
52
53
54
	printf(
"Assemble and process FEL Bragg intensities.\n"
"\n"
55
56
57
"  -h, --help                Display this help message.\n"
"  -i, --input=<filename>    Specify input filename (\"-\" for stdin).\n"
"  -o, --output=<filename>   Specify output filename for merged intensities\n"
58
"                             Default: processed.hkl).\n"
59
"  -p, --pdb=<filename>      PDB file to use (default: molecule.pdb).\n"
60
"  -b, --beam=<file>         Get beam parameters from file (used for sigmas).\n"
Thomas White's avatar
Thomas White committed
61
"\n"
62
63
64
65
66
67
68
69
"      --max-only            Take the integrated intensity to be equal to the\n"
"                             maximum intensity measured for that reflection.\n"
"                             The default is to use the mean value from all\n"
"                             measurements.\n"
"      --sum                 Sum (rather than average) the intensities for the\n"
"                             final output list.  This is useful for comparing\n"
"                             results to radially summed powder patterns, but\n"
"                             will break R-factor analysis.\n"
70
"      --start-after=<n>     Skip n patterns at the start of the stream.\n"
71
72
73
"      --stop-after=<n>      Stop after processing n patterns.  Zero means\n"
"                             keep going until the end of the input, and is\n"
"                             the default.\n"
74
75
"  -g, --histogram=<h,k,l>   Calculate the histogram of measurements for this\n"
"                             reflection.\n"
76
"  -z, --hist-parameters     Set the range for the histogram and the number of\n"
Thomas White's avatar
Thomas White committed
77
"          =<min,max,nbins>   bins. \n"
78
"\n"
79
80
"      --scale               Scale each pattern for best fit with the current\n"
"                             model.\n"
Thomas White's avatar
Thomas White committed
81
"  -y, --symmetry=<sym>      Merge according to point group <sym>.\n"
82
83
"      --reference=<file>    Compare against intensities from <file> when\n"
"                             scaling or resolving ambiguities.\n"
84
85
"                             The symmetry of the reference list must be the\n"
"                             same as that given with '-y'.\n"
86
);
87
88
89
}


90
static void plot_histogram(double *vals, int n, float hist_min, float hist_max, int nbins)
91
92
93
94
95
{
	int i;
	double max = -INFINITY;
	double min = +INFINITY;
	double step;
96
	int histo[nbins];
97
98
99
100
101
102
103
104
	FILE *fh;

	fh = fopen("histogram.dat", "w");
	if ( fh == NULL ) {
		ERROR("Couldn't open 'histogram.dat'\n");
		return;
	}

105
106
107
108
109
110
111
112
	if ( hist_min == hist_max ) {
		for ( i=0; i<n; i++ ) {
			if ( vals[i] > max ) max = vals[i];
			if ( vals[i] < min ) min = vals[i];
		}
	} else {
		min = hist_min;
		max = hist_max;
113
	}
Thomas White's avatar
Thomas White committed
114
	STATUS("min max nbins: %f %f %i\n", min, max, nbins);
115
	min--;  max++;
116

117
	for ( i=0; i<nbins; i++ ) {
118
119
120
		histo[i] = 0;
	}

121
	step = (max-min)/nbins;
122
123
124

	for ( i=0; i<n; i++ ) {
		int bin;
125
126
127
128
		if ( (vals[i] > min) && (vals[i] < max) ) {
			bin = (vals[i]-min)/step;
			histo[bin]++;
		}
129
130
	}

131
	for ( i=0; i<nbins; i++ ) {
132
133
134
135
136
137
138
		fprintf(fh, "%f %i\n", min+step*i, histo[i]);
	}

	fclose(fh);
}


139
static void merge_pattern(RefList *model, RefList *new, int max_only,
Thomas White's avatar
Thomas White committed
140
                          const SymOpList *sym,
141
                          double *hist_vals, signed int hist_h,
142
143
                          signed int hist_k, signed int hist_l, int *hist_n,
                          int pass)
144
{
145
146
	Reflection *refl;
	RefListIterator *iter;
147

148
149
150
	for ( refl = first_refl(new, &iter);
	      refl != NULL;
	      refl = next_refl(refl, iter) ) {
151
152

		double intensity;
153
		signed int h, k, l;
154
155
		Reflection *model_version;
		double model_int;
156

157
		get_indices(refl, &h, &k, &l);
Thomas White's avatar
Thomas White committed
158
159

		/* Put into the asymmetric unit for the target group */
Thomas White's avatar
Thomas White committed
160
		get_asymm(sym, h, k, l, &h, &k, &l);
Thomas White's avatar
Thomas White committed
161

162
163
164
165
		model_version = find_refl(model, h, k, l);
		if ( model_version == NULL ) {
			model_version = add_refl(model, h, k, l);
		}
166

167
168
		/* Read the intensity from the original location
		 * (i.e. before screwing around with symmetry) */
169
170
171
172
		intensity = get_intensity(refl);

		/* Get the current model intensity */
		model_int = get_intensity(model_version);
173

174
175
176
177
178
179
180
181
182
		if ( pass == 1 ) {

			/* User asked for max only? */
			if ( !max_only ) {
				set_int(model_version, model_int + intensity);
			} else {
				if ( intensity>get_intensity(model_version) ) {
					set_int(model_version, intensity);
				}
183
184
			}

185
186
187
188
			/* Increase redundancy */
			int cur_redundancy = get_redundancy(model_version);
			set_redundancy(model_version, cur_redundancy+1);

189

190
191
		} else if ( pass == 2 ) {

192
			double dev = get_temp1(model_version);
193
194
195
196
197
198
199
200
201

			/* Other ways of estimating the sigma are possible,
			 * choose from:
			 *    dev += pow(get_esd_intensity(refl), 2.0);
			 *    dev += pow(intensity, 2.0);
			 * But alter the other part of the calculation below
			 * as well. */
			dev += pow(intensity - model_int, 2.0);

202
			set_temp1(model_version, dev);
203
204
205
206
207
208
209
210
211

			if ( hist_vals != NULL ) {
				int p = *hist_n;
				if ( (h==hist_h) && (k==hist_k)
				  && (l==hist_l) )
				{
					hist_vals[p] = intensity;
					*hist_n = p+1;
				}
Thomas White's avatar
Thomas White committed
212

213
			}
214

215
216
		}

217
	}
218
219


220
221
222
}


223
224
225
enum {
	SCALE_NONE,
	SCALE_CONSTINT,
226
227
	SCALE_INTPERBRAGG,
	SCALE_TWOPASS,
228
229
230
};


Thomas White's avatar
Thomas White committed
231
static void scale_intensities(RefList *model, RefList *new, const SymOpList *sym)
232
233
{
	double s;
234
235
	double top = 0.0;
	double bot = 0.0;
236
	const int scaling = SCALE_INTPERBRAGG;
237
238
239
	Reflection *refl;
	RefListIterator *iter;
	Reflection *model_version;
240

241
242
243
	for ( refl = first_refl(new, &iter);
	      refl != NULL;
	      refl = next_refl(refl, iter) ) {
244
245
246

		double i1, i2;
		signed int hu, ku, lu;
247
		signed int h, k, l;
248

249
		get_indices(refl, &h, &k, &l);
250

251
252
253
		switch ( scaling ) {
		case SCALE_TWOPASS :

254
255
256
			model_version = find_refl(model, h, k, l);
			if ( model_version == NULL ) continue;

Thomas White's avatar
Thomas White committed
257
			get_asymm(sym, h, k, l, &hu, &ku, &lu);
258

259
260
			i1 = get_intensity(model_version);
			i2 = get_intensity(refl);
261
262
263
264

			/* Calculate LSQ estimate of scaling factor */
			top += i1 * i2;
			bot += i2 * i2;
265

266
			break;
267

268
269
270
		case SCALE_CONSTINT :

			/* Sum up the intensity in the pattern */
271
			i2 = get_intensity(refl);
272
273
274
275
			top += i2;

			break;

276
277
278
		case SCALE_INTPERBRAGG :

			/* Sum up the intensity in the pattern */
279
			i2 = get_intensity(refl);
280
281
282
283
284
			top += i2;
			bot += 1.0;

			break;

285
		}
286
287
288

	}

289
290
291
292
293
294
295
	switch ( scaling ) {
	case SCALE_TWOPASS :
		s = top / bot;
		break;
	case SCALE_CONSTINT :
		s = 1000.0 / top;
		break;
296
297
298
	case SCALE_INTPERBRAGG :
		s = 1000.0 / (top/bot);
		break;
299
	}
300
301

	/* Multiply the new pattern up by "s" */
302
303
304
305
306
307
308
	for ( refl = first_refl(new, &iter);
	      refl != NULL;
	      refl = next_refl(refl, iter) ) {

		double intensity = get_intensity(refl);
		set_int(refl, intensity*s);

309
310
311
312
	}
}


313
static void merge_all(FILE *fh, RefList *model,
314
                      int config_maxonly, int config_scale, int config_sum,
315
                      int config_startafter, int config_stopafter,
Thomas White's avatar
Thomas White committed
316
                      const SymOpList *sym,
317
                      int n_total_patterns,
318
319
                      double *hist_vals, signed int hist_h,
                      signed int hist_k, signed int hist_l,
320
                      int *hist_i, int pass)
321
{
322
	int rval;
Thomas White's avatar
Thomas White committed
323
	int n_patterns = 0;
324
325
326
	int n_used = 0;
	Reflection *refl;
	RefListIterator *iter;
327

328
329
330
	if ( skip_some_files(fh, config_startafter) ) {
		ERROR("Failed to skip first %i files.\n", config_startafter);
		return;
331
332
	}

333
334
	do {

335
		struct image image;
336

337
338
		image.det = NULL;

339
340
		/* Get data from next chunk */
		rval = read_chunk(fh, &image);
Thomas White's avatar
Thomas White committed
341
		if ( rval ) break;
342

343
344
345
		n_patterns++;

		if ( (image.reflections != NULL) && (image.indexed_cell) ) {
346
347
348

			/* Scale if requested */
			if ( config_scale ) {
349
350
				scale_intensities(model, image.reflections,
				                  sym);
351
352
			}

353
354
			merge_pattern(model, image.reflections, config_maxonly,
			              sym, hist_vals, hist_h, hist_k, hist_l,
355
			              hist_i, pass);
356

357
			n_used++;
358
359
360

		}

Thomas White's avatar
Thomas White committed
361
		free(image.filename);
362
363
364
		reflist_free(image.reflections);
		image_feature_list_free(image.features);
		cell_free(image.indexed_cell);
365

366
367
		progress_bar(n_patterns, n_total_patterns-config_startafter,
		             "Merging");
368

369
	} while ( rval == 0 );
370

371
	/* Divide by counts to get mean intensity if necessary */
372
	if ( (pass == 1) && !config_sum && !config_maxonly ) {
373

374
375
		Reflection *refl;
		RefListIterator *iter;
376

377
378
379
		for ( refl = first_refl(model, &iter);
		      refl != NULL;
		      refl = next_refl(refl, iter) ) {
380

381
382
			double intensity = get_intensity(refl);
			int red = get_redundancy(refl);
383

384
			set_int(refl, intensity / (double)red);
385

Thomas White's avatar
Thomas White committed
386
		}
387

Thomas White's avatar
Thomas White committed
388
389
	}

390
	/* Calculate ESDs */
391
392
393
394
	if ( pass == 2 ) {
		for ( refl = first_refl(model, &iter);
		      refl != NULL;
		      refl = next_refl(refl, iter) ) {
395

396
			double sum_squared_dev = get_temp1(refl);
397
			int red = get_redundancy(refl);
398
			int h, k, l;
399
			double esd;
400
			get_indices(refl,&h,&k,&l);
401
402
403
404
405
406
407
408
409
410
411
412
413
414

			/* Other ways of estimating the sigma are possible,
			 * such as:
			 *
			 *    double intensity = get_intensity(refl);
			 *    esd = sqrt( (sum_squared_dev/(double)red)
			 *              - pow(intensity,2.0) ) );
			 *
			 * But alter the other part of the calculation above
			 * as well. */
			esd = sqrt(sum_squared_dev)/(double)red;

			set_esd_intensity(refl, esd);

415
		}
416
	}
Thomas White's avatar
Thomas White committed
417

418
419
420
	if ( pass == 1 ) {
		STATUS("%i of the patterns could be used.\n", n_used);
	}
421
422
423
}


424
425
426
427
int main(int argc, char *argv[])
{
	int c;
	char *filename = NULL;
428
	char *output = NULL;
429
	FILE *fh;
430
	RefList *model;
431
	UnitCell *cell = NULL;
Thomas White's avatar
Thomas White committed
432
	int config_maxonly = 0;
433
	int config_startafter = 0;
Thomas White's avatar
Thomas White committed
434
	int config_stopafter = 0;
435
	int config_sum = 0;
436
	int config_scale = 0;
437
	unsigned int n_total_patterns;
Thomas White's avatar
Thomas White committed
438
439
	char *sym_str = NULL;
	SymOpList *sym;
440
	char *pdb = NULL;
441
442
	char *histo = NULL;
	signed int hist_h, hist_k, hist_l;
443
444
	signed int hist_nbins=50;
	float hist_min=0.0, hist_max=0.0;
445
446
	double *hist_vals = NULL;
	int hist_i;
447
	struct beam_params *beam = NULL;
448
	int space_for_hist = 0;
449
	char *histo_params = NULL;
450
451
452
453
454

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
		{"input",              1, NULL,               'i'},
Thomas White's avatar
Thomas White committed
455
		{"output",             1, NULL,               'o'},
Thomas White's avatar
Thomas White committed
456
		{"max-only",           0, &config_maxonly,     1},
Thomas White's avatar
Thomas White committed
457
		{"output-every",       1, NULL,               'e'},
Thomas White's avatar
Thomas White committed
458
		{"stop-after",         1, NULL,               's'},
459
		{"start-after",        1, NULL,               'f'},
460
		{"sum",                0, &config_sum,         1},
461
		{"scale",              0, &config_scale,       1},
462
		{"symmetry",           1, NULL,               'y'},
463
		{"pdb",                1, NULL,               'p'},
464
		{"histogram",          1, NULL,               'g'},
465
		{"hist-parameters",    1, NULL,               'z'},
466
		{"beam",               1, NULL,               'b'},
467
468
469
470
		{0, 0, NULL, 0}
	};

	/* Short options */
471
	while ((c = getopt_long(argc, argv, "hi:e:o:p:y:g:f:b:z:",
472
	                        longopts, NULL)) != -1) {
473
474

		switch (c) {
Thomas White's avatar
Thomas White committed
475
		case 'h' :
476
477
478
			show_help(argv[0]);
			return 0;

Thomas White's avatar
Thomas White committed
479
		case 'i' :
480
481
482
			filename = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
483
		case 'o' :
484
485
486
			output = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
487
		case 's' :
Thomas White's avatar
Thomas White committed
488
489
490
			config_stopafter = atoi(optarg);
			break;

491
492
493
494
		case 'f' :
			config_startafter = atoi(optarg);
			break;

Thomas White's avatar
Thomas White committed
495
		case 'p' :
496
497
498
			pdb = strdup(optarg);
			break;

499
		case 'y' :
Thomas White's avatar
Thomas White committed
500
			sym_str = strdup(optarg);
501
502
			break;

503
504
505
506
		case 'g' :
			histo = strdup(optarg);
			break;

507
508
509
510
		case 'z' :
			histo_params = strdup(optarg);
			break;

511
512
513
514
515
516
517
518
519
		case 'b' :
			beam = get_beam_parameters(optarg);
			if ( beam == NULL ) {
				ERROR("Failed to load beam parameters"
				      " from '%s'\n", optarg);
				return 1;
			}
			break;

Thomas White's avatar
Thomas White committed
520
		case 0 :
521
522
			break;

Thomas White's avatar
Thomas White committed
523
		default :
524
525
526
527
528
529
530
531
532
533
			return 1;
		}

	}

	if ( filename == NULL ) {
		ERROR("Please specify filename using the -i option\n");
		return 1;
	}

534
535
536
537
	if ( output == NULL ) {
		output = strdup("processed.hkl");
	}

538
539
540
541
542
543
544
545
546
	if ( pdb != NULL ) {
		cell = load_cell_from_pdb(pdb);
		if ( cell == NULL ) {
			ERROR("Failed to load cell from '%s'\n", pdb);
			return 1;
		}
		free(pdb);
	} else {
		cell = NULL;
Thomas White's avatar
Thomas White committed
547
	}
Thomas White's avatar
Thomas White committed
548

Thomas White's avatar
Thomas White committed
549
550
551
	if ( sym_str == NULL ) sym_str = strdup("1");
	sym = get_pointgroup(sym_str);
	free(sym_str);
552

553
554
555
556
557
558
559
560
561
562
563
	/* Open the data stream */
	if ( strcmp(filename, "-") == 0 ) {
		fh = stdin;
	} else {
		fh = fopen(filename, "r");
	}
	free(filename);
	if ( fh == NULL ) {
		ERROR("Failed to open input file\n");
		return 1;
	}
Thomas White's avatar
Tidy-up    
Thomas White committed
564

565
566
	/* Count the number of patterns in the file */
	n_total_patterns = count_patterns(fh);
Thomas White's avatar
Thomas White committed
567
568
569
570
	if ( n_total_patterns == 0 ) {
		ERROR("No patterns to process.\n");
		return 1;
	}
571
572
	STATUS("There are %i patterns to process\n", n_total_patterns);
	rewind(fh);
573

574
575
	model = reflist_new();

576
	if ( histo != NULL ) {
Thomas White's avatar
Thomas White committed
577

578
		int r;
Thomas White's avatar
Thomas White committed
579

580
581
582
583
584
		r = sscanf(histo, "%i,%i,%i", &hist_h, &hist_k, &hist_l);
		if ( r != 3 ) {
			ERROR("Invalid indices for '--histogram'\n");
			return 1;
		}
Thomas White's avatar
Thomas White committed
585

Thomas White's avatar
Thomas White committed
586
		space_for_hist = n_total_patterns * num_equivs(sym, NULL);
587
588
589
		hist_vals = malloc(space_for_hist * sizeof(double));
		free(histo);
		STATUS("Histogramming %i %i %i -> ", hist_h, hist_k, hist_l);
Thomas White's avatar
Thomas White committed
590

591
		/* Put into the asymmetric cell for the target group */
Thomas White's avatar
Thomas White committed
592
593
		get_asymm(sym, hist_h, hist_k, hist_l,
		          &hist_h, &hist_k, &hist_l);
594
		STATUS("%i %i %i\n", hist_h, hist_k, hist_l);
Thomas White's avatar
Thomas White committed
595

596
597
	}

598
	if ( histo_params != NULL ) {
Thomas White's avatar
Thomas White committed
599

600
		int rr;
Thomas White's avatar
Thomas White committed
601
602
603

		rr = sscanf(histo_params, "%f,%f,%i", &hist_min, &hist_max,
		                                      &hist_nbins);
604
605
606
607
608
		if ( rr != 3 ) {
			ERROR("Invalid parameters for '--hist-parameters'\n");
			return 1;
		}
		free(histo_params);
Thomas White's avatar
Thomas White committed
609
610
611
		if ( hist_max <= hist_min ) {
			ERROR("Invalid range for '--hist-parameters'. "
			      "Make sure that 'max' is greater than 'min'.\n");
612
613
			return 1;
		}
Thomas White's avatar
Thomas White committed
614

615
616
	}

617
	hist_i = 0;
618
	merge_all(fh, model, config_maxonly, config_scale, config_sum,
619
	          config_startafter, config_stopafter,
620
                  sym, n_total_patterns,
621
                  NULL, 0, 0, 0, NULL, 1);
Thomas White's avatar
Thomas White committed
622
623
624
625
	if ( ferror(fh) ) {
		ERROR("Stream read error.\n");
		return 1;
	}
626
	rewind(fh);
627

628
629
	STATUS("Extra pass to calculate ESDs...\n");
	rewind(fh);
630
631
	merge_all(fh, model, config_maxonly, config_scale, 0,
	          config_startafter, config_stopafter, sym, n_total_patterns,
632
	          hist_vals, hist_h, hist_k, hist_l, &hist_i, 2);
Thomas White's avatar
Thomas White committed
633
634
635
636
	if ( ferror(fh) ) {
		ERROR("Stream read error.\n");
		return 1;
	}
637

638
639
640
641
642
643
644
645
646
647
648
	if ( space_for_hist && (hist_i >= space_for_hist) ) {
		ERROR("Histogram array was too small!\n");
	}

	if ( hist_vals != NULL ) {
		STATUS("%i %i %i was seen %i times.\n", hist_h, hist_k, hist_l,
		                                        hist_i);
		plot_histogram(hist_vals, hist_i, hist_min, hist_max,
		               hist_nbins);
	}

649
	write_reflist(output, model, cell);
650
651

	fclose(fh);
652

653
	free(sym);
654
	reflist_free(model);
Thomas White's avatar
Thomas White committed
655
	free(output);
656
	if ( cell != NULL ) cell_free(cell);
657

658
659
	return 0;
}