check_hkl.c 9.33 KB
Newer Older
1
2
3
4
5
/*
 * check_hkl.c
 *
 * Characterise reflection lists
 *
Thomas White's avatar
Thomas White committed
6
 * Copyright © 2012 Thomas White <taw@physics.org>
7
 *
Thomas White's avatar
Thomas White committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 * 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/>.
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 *
 */


#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
40
41
#include "reflist.h"
#include "reflist-utils.h"
42
43
44
45
46
47
48
49
50
51
52
53
54


/* 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"
Thomas White's avatar
Thomas White committed
55
"  -y, --symmetry=<sym>       The symmetry of the input file.\n"
Thomas White's avatar
Thomas White committed
56
57
58
"  -p, --pdb=<filename>       PDB file to use.\n"
"      --rmin=<res>           Fix lower resolution limit for resolution shells. (m^-1).\n"
"      --rmax=<res>           Fix upper resolution limit for resolution shells. (m^-1).\n"
Thomas White's avatar
Thomas White committed
59
"      --sigma-cutoff=<n>     Discard reflections with I/sigma(I) < n.\n"
60
61
62
63
"\n");
}


Thomas White's avatar
Thomas White committed
64
static void plot_shells(RefList *list, UnitCell *cell, const SymOpList *sym,
Thomas White's avatar
Thomas White committed
65
                        double rmin_fix, double rmax_fix)
66
67
68
69
70
71
72
73
74
75
{
	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
76
77
	double mean[NBINS];
	double var[NBINS];
78
79
80
81
82
83
84
85
	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
86
87
	Reflection *refl;
	RefListIterator *iter;
88
	RefList *counted;
89
90
91
92
	int hmax, kmax, lmax;
	double asx, asy, asz;
	double bsx, bsy, bsz;
	double csx, csy, csz;
93
94
95
96
97
98
99
100
101
102
103
104
105
106

	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
107
108
		var[i] = 0;
		mean[i] = 0;
109
110
	}

111
	resolution_limits(list, cell, &rmin, &rmax);
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
	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 */
149
	counted = reflist_new();
150
151
152
153
154
155
156
157
158
	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++ ) {
159
160
161
162
163

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

164
		d = 2.0 * resolution(cell, h, k, l);
165
166
167
168
169
170
171
172
173
174

		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
175
		get_asymm(sym, h, k, l, &hs, &ks, &ls);
176
177
		if ( find_refl(counted, hs, ks, ls) != NULL ) continue;
		add_refl(counted, hs, ks, ls);
Thomas White's avatar
Thomas White committed
178

179
180
181
182
183
		possible[bin]++;

	}
	}
	}
184
	reflist_free(counted);
185

186
	/* Calculate means */
Thomas White's avatar
Thomas White committed
187
188
	for ( refl = first_refl(list, &iter);
	      refl != NULL;
189
190
	      refl = next_refl(refl, iter) )
	{
191
192
193
194
195
		signed int h, k, l;
		double d;
		int bin;
		int j;

Thomas White's avatar
Thomas White committed
196
		get_indices(refl, &h, &k, &l);
197
198
199
200
201
202
203
204
205
206

		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;
			}
		}
207
		if ( bin == -1 ) continue;
208
209

		measured[bin]++;
Thomas White's avatar
Thomas White committed
210
		mean[bin] += get_intensity(refl);
211
212
213
214
215
216
217
	}

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

	/* Characterise the data set */
Thomas White's avatar
Thomas White committed
218
219
	for ( refl = first_refl(list, &iter);
	      refl != NULL;
220
221
	      refl = next_refl(refl, iter) )
	{
222
223
224
225
226
227
		signed int h, k, l;
		double d;
		int bin;
		int j;
		double val, esd;

Thomas White's avatar
Thomas White committed
228
		get_indices(refl, &h, &k, &l);
229
230

		d = resolution(cell, h, k, l) * 2.0;
Thomas White's avatar
Thomas White committed
231
232
		val = get_intensity(refl);
		esd = get_esd_intensity(refl);
233
234
235
236
237
238
239
240
241
242
243
244
245

		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
246
247
		if ( !isfinite(val/esd) ) continue;

248
		/* measured[bin] was done earlier */
Thomas White's avatar
Thomas White committed
249
		measurements[bin] += get_redundancy(refl);
250
251
		snr[bin] += val / esd;
		snr_total += val / esd;
252
		nmeas++;
Thomas White's avatar
Thomas White committed
253
		nmeastot += get_redundancy(refl);
254

255
		var[bin] += pow(val-mean[bin], 2.0);
256
257
258
259
260
261
262
263
264
265
	}
	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);
	}

266
267
	fprintf(fh, "1/d centre   # refs Possible  Compl       "
		    "Meas   Red   SNR    Std dev       Mean\n");
268
269
	for ( i=0; i<NBINS; i++ ) {

270
		double cen;
271
		cen = rmins[i] + (rmaxs[i] - rmins[i])/2.0;
Thomas White's avatar
Thomas White committed
272
273
		fprintf(fh, "%10.3f %8i %8i %6.2f %10i %5.1f"
		            " %5.2f %10.2f %10.2f\n",
274
275
276
277
278
279
280
281
282
		        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]);
283
284
285
286

	}

	fclose(fh);
Thomas White's avatar
Thomas White committed
287
288

	STATUS("Resolution shell information written to shells.dat.\n");
289
290
291
292
293
294
295
296
}


int main(int argc, char *argv[])
{
	int c;
	UnitCell *cell;
	char *file = NULL;
Thomas White's avatar
Thomas White committed
297
298
	char *sym_str = NULL;
	SymOpList *sym;
Thomas White's avatar
Thomas White committed
299
300
301
302
	RefList *raw_list;
	RefList *list;
	Reflection *refl;
	RefListIterator *iter;
303
304
305
306
	char *pdb = NULL;
	int rej = 0;
	float rmin_fix = -1.0;
	float rmax_fix = -1.0;
Thomas White's avatar
Thomas White committed
307
	float sigma_cutoff = -INFINITY;
308
309
310
311
312
313

	/* 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
314
315
316
		{"rmin",               1, NULL,                2},
		{"rmax",               1, NULL,                3},
		{"sigma-cutoff",       1, NULL,                4},
317
318
319
320
321
322
323
324
325
326
327
328
		{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
329
			sym_str = strdup(optarg);
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
			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
353
354
355
356
357
358
359
		case 4 :
			if ( sscanf(optarg, "%f", &sigma_cutoff) != 1 ) {
				ERROR("Invalid value for --sigma-cutoff\n");
				return 1;
			}
			break;

360
361
362
363
364
365
366
		default :
			return 1;
		}

	}

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

Thomas White's avatar
Thomas White committed
371
372
	if ( sym_str == NULL ) {
		sym_str = strdup("1");
373
	}
Thomas White's avatar
Thomas White committed
374
375
	sym = get_pointgroup(sym_str);
	free(sym_str);
376
377
378
379

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

	if ( pdb == NULL ) {
Thomas White's avatar
Thomas White committed
380
381
382
		ERROR("You need to provide a PDB file containing"
		       " the unit cell.\n");
		return 1;
383
384
385
386
	}
	cell = load_cell_from_pdb(pdb);
	free(pdb);

Thomas White's avatar
Thomas White committed
387
388
389
	raw_list = read_reflections(file);
	if ( raw_list == NULL ) {
		ERROR("Couldn't read file '%s'\n", file);
390
391
392
		return 1;
	}

Thomas White's avatar
Thomas White committed
393
	/* Check that the intensities have the correct symmetry */
Thomas White's avatar
Thomas White committed
394
	if ( check_list_symmetry(raw_list, sym) ) {
Thomas White's avatar
Thomas White committed
395
		ERROR("The input reflection list does not appear to"
Thomas White's avatar
Thomas White committed
396
		      " have symmetry %s\n", symmetry_name(sym));
Thomas White's avatar
Thomas White committed
397
398
399
		return 1;
	}

Thomas White's avatar
Thomas White committed
400
401
	/* Reject some reflections */
	list = reflist_new();
Thomas White's avatar
Thomas White committed
402
	for ( refl = first_refl(raw_list, &iter);
Thomas White's avatar
Thomas White committed
403
404
	      refl != NULL;
	      refl = next_refl(refl, iter) ) {
405
406
407
408

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

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

Thomas White's avatar
Thomas White committed
413
414
		val = get_intensity(refl);
		sig = get_esd_intensity(refl);
415

Thomas White's avatar
Thomas White committed
416
		if ( val < sigma_cutoff * sig ) {
417
418
419
420
			rej++;
			ig = 1;
		}

Thomas White's avatar
Thomas White committed
421
		if ( ig ) continue;
422

Thomas White's avatar
Thomas White committed
423
424
		new = add_refl(list, h, k, l);
		copy_data(new, refl);
425
426

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

Thomas White's avatar
Thomas White committed
430
	plot_shells(list, cell, sym, rmin_fix, rmax_fix);
431
432
433

	return 0;
}