check_hkl.c 8.76 KB
Newer Older
1
2
3
4
5
/*
 * check_hkl.c
 *
 * Characterise reflection lists
 *
Thomas White's avatar
Thomas White committed
6
 * (c) 2006-2011 Thomas White <taw@physics.org>
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 *
 * 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 "utils.h"
#include "statistics.h"
#include "symmetry.h"
Thomas White's avatar
Thomas White committed
27
28
#include "reflist.h"
#include "reflist-utils.h"
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45


/* Number of bins for plot of resolution shells */
#define NBINS (10)


static void show_help(const char *s)
{
	printf("Syntax: %s [options] <file.hkl>\n\n", s);
	printf(
"Characterise an intensity list.\n"
"\n"
"  -h, --help                 Display this help message.\n"
"  -y, --symmetry=<sym>       The symmetry of both the input files.\n"
"  -p, --pdb=<filename>       PDB file to use (default: molecule.pdb).\n"
"      --rmin=<res>           Fix lower resolution limit for --shells (m^-1).\n"
"      --rmax=<res>           Fix upper resolution limit for --shells (m^-1).\n"
Thomas White's avatar
Thomas White committed
46
"      --sigma-cutoff=<n>     Discard reflections with I/sigma(I) < n.\n"
47
48
49
50
"\n");
}


Thomas White's avatar
Thomas White committed
51
static void plot_shells(RefList *list, UnitCell *cell, const SymOpList *sym,
Thomas White's avatar
Thomas White committed
52
                        double rmin_fix, double rmax_fix)
53
54
55
56
57
58
59
60
61
62
{
	double num[NBINS];
	int cts[NBINS];
	int possible[NBINS];
	unsigned int measurements[NBINS];
	unsigned int measured[NBINS];
	double total_vol, vol_per_shell;
	double rmins[NBINS];
	double rmaxs[NBINS];
	double snr[NBINS];
Thomas White's avatar
Thomas White committed
63
64
	double mean[NBINS];
	double var[NBINS];
65
66
67
68
69
70
71
72
	double rmin, rmax;
	signed int h, k, l;
	int i;
	FILE *fh;
	double snr_total = 0;
	int nmeas = 0;
	int nmeastot = 0;
	int nout = 0;
Thomas White's avatar
Thomas White committed
73
74
	Reflection *refl;
	RefListIterator *iter;
75
	RefList *counted;
76
77
78
79
	int hmax, kmax, lmax;
	double asx, asy, asz;
	double bsx, bsy, bsz;
	double csx, csy, csz;
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

	if ( cell == NULL ) {
		ERROR("Need the unit cell to plot resolution shells.\n");
		return;
	}

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

	for ( i=0; i<NBINS; i++ ) {
		num[i] = 0.0;
		cts[i] = 0;
		possible[i] = 0;
		measured[i] = 0;
		measurements[i] = 0;
		snr[i] = 0;
Thomas White's avatar
Thomas White committed
99
100
		var[i] = 0;
		mean[i] = 0;
101
102
	}

103
	resolution_limits(list, cell, &rmin, &rmax);
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
	STATUS("1/d goes from %f to %f nm^-1\n", rmin/1e9, rmax/1e9);

	/* Widen the range just a little bit */
	rmin -= 0.001e9;
	rmax += 0.001e9;

	/* Fixed resolution shells if needed */
	if ( rmin_fix > 0.0 ) rmin = rmin_fix;
	if ( rmax_fix > 0.0 ) rmax = rmax_fix;

	total_vol = pow(rmax, 3.0) - pow(rmin, 3.0);
	vol_per_shell = total_vol / NBINS;
	rmins[0] = rmin;
	for ( i=1; i<NBINS; i++ ) {

		double r;

		r = vol_per_shell + pow(rmins[i-1], 3.0);
		r = pow(r, 1.0/3.0);

		/* Shells of constant volume */
		rmaxs[i-1] = r;
		rmins[i] = r;

		/* Shells of constant thickness */
		//rmins[i] = rmins[i-1] + (rmax-rmin)/NBINS;
		//rmaxs[i-1] = rmins[i-1] + (rmax-rmin)/NBINS;

		STATUS("Shell %i: %f to %f\n", i-1,
		       rmins[i-1]/1e9, rmaxs[i-1]/1e9);

	}
	rmaxs[NBINS-1] = rmax;
	STATUS("Shell %i: %f to %f\n", NBINS-1,
	       rmins[NBINS-1]/1e9, rmaxs[NBINS-1]/1e9);

	/* Count the number of reflections possible in each shell */
141
	counted = reflist_new();
142
143
144
145
146
147
148
149
150
	cell_get_reciprocal(cell, &asx, &asy, &asz,
	                          &bsx, &bsy, &bsz,
	                          &csx, &csy, &csz);
	hmax = rmax / modulus(asx, asy, asz);
	kmax = rmax / modulus(bsx, bsy, bsz);
	lmax = rmax / modulus(csx, csy, csz);
	for ( h=-hmax; h<hmax; h++ ) {
	for ( k=-kmax; k<kmax; k++ ) {
	for ( l=-lmax; l<lmax; l++ ) {
151
152
153
154
155

		double d;
		signed int hs, ks, ls;
		int bin;

156
		d = 2.0 * resolution(cell, h, k, l);
157
158
159
160
161
162
163
164
165
166

		bin = -1;
		for ( i=0; i<NBINS; i++ ) {
			if ( (d>rmins[i]) && (d<=rmaxs[i]) ) {
				bin = i;
				break;
			}
		}
		if ( bin == -1 ) continue;

Thomas White's avatar
Thomas White committed
167
		get_asymm(sym, h, k, l, &hs, &ks, &ls);
168
169
		if ( find_refl(counted, hs, ks, ls) != NULL ) continue;
		add_refl(counted, hs, ks, ls);
Thomas White's avatar
Thomas White committed
170

171
172
173
174
175
		possible[bin]++;

	}
	}
	}
176
	reflist_free(counted);
177

178
	/* Calculate means */
Thomas White's avatar
Thomas White committed
179
180
	for ( refl = first_refl(list, &iter);
	      refl != NULL;
181
182
	      refl = next_refl(refl, iter) )
	{
183
184
185
186
187
		signed int h, k, l;
		double d;
		int bin;
		int j;

Thomas White's avatar
Thomas White committed
188
		get_indices(refl, &h, &k, &l);
189
190
191
192
193
194
195
196
197
198

		d = resolution(cell, h, k, l) * 2.0;

		bin = -1;
		for ( j=0; j<NBINS; j++ ) {
			if ( (d>rmins[j]) && (d<=rmaxs[j]) ) {
				bin = j;
				break;
			}
		}
199
		if ( bin == -1 ) continue;
200
201

		measured[bin]++;
Thomas White's avatar
Thomas White committed
202
		mean[bin] += get_intensity(refl);
203
204
205
206
207
208
209
	}

	for ( i=0; i<NBINS; i++ ) {
		mean[i] /= (double)measured[i];
	}

	/* Characterise the data set */
Thomas White's avatar
Thomas White committed
210
211
	for ( refl = first_refl(list, &iter);
	      refl != NULL;
212
213
	      refl = next_refl(refl, iter) )
	{
214
215
216
217
218
219
		signed int h, k, l;
		double d;
		int bin;
		int j;
		double val, esd;

Thomas White's avatar
Thomas White committed
220
		get_indices(refl, &h, &k, &l);
221
222

		d = resolution(cell, h, k, l) * 2.0;
Thomas White's avatar
Thomas White committed
223
224
		val = get_intensity(refl);
		esd = get_esd_intensity(refl);
225
226
227
228
229
230
231
232
233
234
235
236
237

		bin = -1;
		for ( j=0; j<NBINS; j++ ) {
			if ( (d>rmins[j]) && (d<=rmaxs[j]) ) {
				bin = j;
				break;
			}
		}
		if ( bin == -1 ) {
			nout++;
			continue;
		}

Thomas White's avatar
Thomas White committed
238
239
		if ( !isfinite(val/esd) ) continue;

240
		/* measured[bin] was done earlier */
Thomas White's avatar
Thomas White committed
241
		measurements[bin] += get_redundancy(refl);
242
243
		snr[bin] += val / esd;
		snr_total += val / esd;
244
		nmeas++;
Thomas White's avatar
Thomas White committed
245
		nmeastot += get_redundancy(refl);
246

247
		var[bin] += pow(val-mean[bin], 2.0);
248
249
250
251
252
253
254
255
256
257
	}
	STATUS("overall <snr> = %f\n", snr_total/(double)nmeas);
	STATUS("%i measurements in total.\n", nmeastot);
	STATUS("%i reflections in total.\n", nmeas);

	if ( nout ) {
		STATUS("Warning; %i reflections outside resolution range.\n",
		       nout);
	}

258
259
	fprintf(fh, "1/d centre   # refs Possible  Compl       "
		    "Meas   Red   SNR    Std dev       Mean\n");
260
261
	for ( i=0; i<NBINS; i++ ) {

262
		double cen;
263
		cen = rmins[i] + (rmaxs[i] - rmins[i])/2.0;
Thomas White's avatar
Thomas White committed
264
265
		fprintf(fh, "%10.3f %8i %8i %6.2f %10i %5.1f"
		            " %5.2f %10.2f %10.2f\n",
266
267
268
269
270
271
272
273
274
		        cen*1.0e-9,
		        measured[i],
		        possible[i],
		        100.0*(float)measured[i]/possible[i],
		        measurements[i],
		        (float)measurements[i]/measured[i],
		        snr[i]/(double)measured[i],
		        sqrt(var[i]/measured[i]),
		        mean[i]);
275
276
277
278

	}

	fclose(fh);
Thomas White's avatar
Thomas White committed
279
280

	STATUS("Resolution shell information written to shells.dat.\n");
281
282
283
284
285
286
287
288
}


int main(int argc, char *argv[])
{
	int c;
	UnitCell *cell;
	char *file = NULL;
Thomas White's avatar
Thomas White committed
289
290
	char *sym_str = NULL;
	SymOpList *sym;
Thomas White's avatar
Thomas White committed
291
292
293
294
	RefList *raw_list;
	RefList *list;
	Reflection *refl;
	RefListIterator *iter;
295
296
297
298
	char *pdb = NULL;
	int rej = 0;
	float rmin_fix = -1.0;
	float rmax_fix = -1.0;
Thomas White's avatar
Thomas White committed
299
	float sigma_cutoff = -INFINITY;
300
301
302
303
304
305

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
		{"symmetry",           1, NULL,               'y'},
		{"pdb",                1, NULL,               'p'},
Thomas White's avatar
Thomas White committed
306
307
308
		{"rmin",               1, NULL,                2},
		{"rmax",               1, NULL,                3},
		{"sigma-cutoff",       1, NULL,                4},
309
310
311
312
313
314
315
316
317
318
319
320
		{0, 0, NULL, 0}
	};

	/* Short options */
	while ((c = getopt_long(argc, argv, "hy:p:", longopts, NULL)) != -1) {

		switch (c) {
		case 'h' :
			show_help(argv[0]);
			return 0;

		case 'y' :
Thomas White's avatar
Thomas White committed
321
			sym_str = strdup(optarg);
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
			break;

		case 'p' :
			pdb = strdup(optarg);
			break;

		case 0 :
			break;

		case 2 :
			if ( sscanf(optarg, "%e", &rmin_fix) != 1 ) {
				ERROR("Invalid value for --rmin\n");
				return 1;
			}
			break;

		case 3 :
			if ( sscanf(optarg, "%e", &rmax_fix) != 1 ) {
				ERROR("Invalid value for --rmax\n");
				return 1;
			}
			break;

Thomas White's avatar
Thomas White committed
345
346
347
348
349
350
351
		case 4 :
			if ( sscanf(optarg, "%f", &sigma_cutoff) != 1 ) {
				ERROR("Invalid value for --sigma-cutoff\n");
				return 1;
			}
			break;

352
353
354
355
356
357
358
		default :
			return 1;
		}

	}

	if ( argc != (optind+1) ) {
Thomas White's avatar
Thomas White committed
359
		ERROR("Please provide exactly one HKL file to check.\n");
360
361
362
		return 1;
	}

Thomas White's avatar
Thomas White committed
363
364
	if ( sym_str == NULL ) {
		sym_str = strdup("1");
365
	}
Thomas White's avatar
Thomas White committed
366
367
	sym = get_pointgroup(sym_str);
	free(sym_str);
368
369
370
371
372
373
374
375
376

	file = strdup(argv[optind++]);

	if ( pdb == NULL ) {
		pdb = strdup("molecule.pdb");
	}
	cell = load_cell_from_pdb(pdb);
	free(pdb);

Thomas White's avatar
Thomas White committed
377
378
379
	raw_list = read_reflections(file);
	if ( raw_list == NULL ) {
		ERROR("Couldn't read file '%s'\n", file);
380
381
382
		return 1;
	}

Thomas White's avatar
Thomas White committed
383
	/* Check that the intensities have the correct symmetry */
Thomas White's avatar
Thomas White committed
384
	if ( check_list_symmetry(raw_list, sym) ) {
Thomas White's avatar
Thomas White committed
385
		ERROR("The input reflection list does not appear to"
Thomas White's avatar
Thomas White committed
386
		      " have symmetry %s\n", symmetry_name(sym));
Thomas White's avatar
Thomas White committed
387
388
389
		return 1;
	}

Thomas White's avatar
Thomas White committed
390
391
	/* Reject some reflections */
	list = reflist_new();
Thomas White's avatar
Thomas White committed
392
	for ( refl = first_refl(raw_list, &iter);
Thomas White's avatar
Thomas White committed
393
394
	      refl != NULL;
	      refl = next_refl(refl, iter) ) {
395
396
397
398

		signed int h, k, l;
		double val, sig;
		int ig = 0;
Thomas White's avatar
Thomas White committed
399
		Reflection *new;
400

Thomas White's avatar
Thomas White committed
401
		get_indices(refl, &h, &k, &l);
402

Thomas White's avatar
Thomas White committed
403
404
		val = get_intensity(refl);
		sig = get_esd_intensity(refl);
405

Thomas White's avatar
Thomas White committed
406
		if ( val < sigma_cutoff * sig ) {
407
408
409
410
			rej++;
			ig = 1;
		}

Thomas White's avatar
Thomas White committed
411
		if ( ig ) continue;
412

Thomas White's avatar
Thomas White committed
413
414
		new = add_refl(list, h, k, l);
		copy_data(new, refl);
415
416

	}
Thomas White's avatar
Thomas White committed
417
418
	STATUS("Discarded %i reflections (out of %i) with I/sigma(I) < %f\n",
	       rej, num_reflections(raw_list), sigma_cutoff);
419

Thomas White's avatar
Thomas White committed
420
	plot_shells(list, cell, sym, rmin_fix, rmax_fix);
421
422
423

	return 0;
}