get_hkl.c 10 KB
Newer Older
1
2
3
/*
 * get_hkl.c
 *
4
 * Small program to manipulate reflection lists
5
 *
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
 *
 * 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 "reflections.h"
26
#include "symmetry.h"
27
#include "beam-parameters.h"
28
29
30
31
32
33


static void show_help(const char *s)
{
	printf("Syntax: %s [options]\n\n", s);
	printf(
34
"Manipulate reflection lists.\n"
35
"\n"
Thomas White's avatar
Thomas White committed
36
37
"  -h, --help                 Display this help message.\n"
"\n"
38
39
40
41
"  -i, --input=<file>         Read reflections from <file>.\n"
"  -y, --symmetry=<sym>       The symmetry of the input reflection list.\n"
"\n"
"You can add noise to the reflections with either of:\n"
Thomas White's avatar
Thomas White committed
42
"      --poisson              Simulate Poisson samples.\n"
43
"      --noise                Add 10%% random noise.\n"
44
45
46
47
48
"\n"
"To calculate Poisson samples accurately, you must also give:\n"
"  -b, --beam=<file>          Get beam parameters from file.\n"
"\n"
"You can artificially 'twin' the reflections, or expand them out:\n"
49
50
"  -w, --twin=<sym>           Generate twinned data according to the given\n"
"                              point group.\n"
Thomas White's avatar
Thomas White committed
51
"  -e, --expand=<sym>         Expand reflections to this point group.\n"
52
53
54
55
56
"\n"
"You can restrict which reflections are written out:\n"
"  -t, --template=<filename>  Only include reflections mentioned in file.\n"
"\n"
"You might sometimes need to do this:\n"
57
58
"      --multiplicity         Multiply intensities by the number of\n"
"                              equivalent reflections.\n"
59
60
61
"\n"
"Don't forget to specify the output filename:\n"
"  -o, --output=<filename>    Output filename (default: stdout).\n"
Thomas White's avatar
Thomas White committed
62
);
Thomas White's avatar
Thomas White committed
63
64
65
66
}


/* Apply Poisson noise to all reflections */
67
static void poisson_reflections(double *ref, ReflItemList *items)
Thomas White's avatar
Thomas White committed
68
{
69
70
	int i;
	const int n = num_items(items);
Thomas White's avatar
Thomas White committed
71

72
	for ( i=0; i<n; i++ ) {
Thomas White's avatar
Thomas White committed
73

74
		struct refl_item *it;
Thomas White's avatar
Thomas White committed
75
		double val;
Thomas White's avatar
Thomas White committed
76
		int c;
Thomas White's avatar
Thomas White committed
77

78
79
80
		it = get_item(items, i);

		val = lookup_intensity(ref, it->h, it->k, it->l);
Thomas White's avatar
Thomas White committed
81
		c = poisson_noise(val);
82
83
84
		set_intensity(ref, it->h, it->k, it->l, c);

		progress_bar(i, n-1, "Simulating noise");
Thomas White's avatar
Thomas White committed
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
}


/* Apply 10% uniform noise to all reflections */
static void noise_reflections(double *ref, ReflItemList *items)
{
	int i;
	const int n = num_items(items);

	for ( i=0; i<n; i++ ) {

		struct refl_item *it;
		double val;
		double r;

		it = get_item(items, i);

		val = lookup_intensity(ref, it->h, it->k, it->l);

		r = (double)random()/RAND_MAX;
		val += 0.1 * val * r;

		set_intensity(ref, it->h, it->k, it->l, val);

		progress_bar(i, n-1, "Simulating noise");

Thomas White's avatar
Thomas White committed
113
	}
114
115
116
}


117
static ReflItemList *twin_reflections(double *ref, ReflItemList *items,
118
119
                                      const char *holo, const char *mero,
                                      double *esds)
120
121
122
123
124
125
{
	int i;
	ReflItemList *new;

	new = new_items();

126
127
128
129
130
	if ( num_general_equivs(holo) < num_general_equivs(mero) ) {
		ERROR("%s is not a subgroup of %s!\n", mero, holo);
		return NULL;
	}

131
132
	for ( i=0; i<num_items(items); i++ ) {

133
		double total, sigma;
134
135
136
137
138
139
140
		struct refl_item *it;
		signed int h, k, l;
		int n, j;
		int skip;

		it = get_item(items, i);

141
		/* There is a many-to-one correspondence between reflections
Thomas White's avatar
Thomas White committed
142
143
144
		 * in the merohedral and holohedral groups.  Do the calculation
		 * only once for each reflection in the holohedral group, which
		 * contains fewer reflections.
145
		 */
146
147
		get_asymm(it->h, it->k, it->l, &h, &k, &l, holo);
		if ( find_item(new, h, k, l) ) continue;
148
149
150

		n = num_equivs(h, k, l, holo);

151
152
		total = 0.0;
		sigma = 0.0;
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
		skip = 0;
		for ( j=0; j<n; j++ ) {

			signed int he, ke, le;
			signed int hu, ku, lu;

			get_equiv(h, k, l, &he, &ke, &le, holo, j);

			/* Do we have this reflection?
			 * We might not have the particular (merohedral)
			 * equivalent which belongs to our definition of the
			 * asymmetric unit cell, so check them all.
			 */
			if ( !find_unique_equiv(items, he, ke, le, mero,
			                        &hu, &ku, &lu) ) {
				/* Don't have this reflection, so bail out */
				ERROR("Twinning %i %i %i requires the %i %i %i "
				      "reflection (or an equivalent in %s), "
				      "which I don't have. %i %i %i won't "
				      "appear in the output\n",
				      h, k, l, he, ke, le, mero, h, k, l);
				skip = 1;
				break;
			}

178
			total += lookup_intensity(ref, hu, ku, lu);
179
			sigma += pow(lookup_sigma(esds, hu, ku, lu), 2.0);
180
181
182
183
184

		}

		if ( !skip ) {

185
			set_intensity(ref, h, k, l, total);
186
			set_sigma(esds, h, k, l, sqrt(sigma));
187
188
189
190
191
192
193
194
195
196
			add_item(new, h, k, l);

		}

	}

	return new;
}


Thomas White's avatar
Thomas White committed
197
198
199
200
201
202
203
204
static ReflItemList *expand_reflections(double *ref, ReflItemList *items,
                                        const char *target, const char *initial)
{
	int i;
	ReflItemList *new;

	new = new_items();

205
206
207
208
209
	if ( num_general_equivs(target) > num_general_equivs(initial) ) {
		ERROR("%s is not a subgroup of %s!\n", initial, target);
		return NULL;
	}

Thomas White's avatar
Thomas White committed
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
	for ( i=0; i<num_items(items); i++ ) {

		struct refl_item *it;
		signed int h, k, l;
		signed int hd, kd, ld;
		int n, j;
		double intensity;

		it = get_item(items, i);
		h = it->h;  k = it->k;  l = it->l;

		/* Actually we don't really care what the equivalent is,
		 * we just want to be sure that there is nly be one version of
		 * this reflection. */
		find_unique_equiv(items, h, k, l, initial, &hd, &kd, &ld);

		/* Now find out how many reflections need to be filled in */
		n = num_equivs(h, k, l, initial);
		intensity = lookup_intensity(ref, h, k, l);

		for ( j=0; j<n; j++ ) {

			signed int he, ke, le;

			/* Get the equivalent */
			get_equiv(h, k, l, &he, &ke, &le, initial, j);

			/* Put it into the asymmetric unit for the target */
			get_asymm(he, ke, le, &he, &ke, &le, target);

			/* Make sure the intensity is in the right place */
			set_intensity(ref, he, ke, le, intensity);

			/* Add the reflection, but only once */
			if ( !find_item(new, he, ke, le) ) {
				add_item(new, he, ke, le);
			}

		}

	}

	return new;
}


256
257
258
int main(int argc, char *argv[])
{
	int c;
Thomas White's avatar
Thomas White committed
259
	double *ideal_ref;
260
	double *phases;
261
	double *esds;
Thomas White's avatar
Thomas White committed
262
	char *template = NULL;
263
264
	int config_noise = 0;
	int config_poisson = 0;
265
266
	int config_nophase = 0;
	int config_multi = 0;
267
268
	char *holo = NULL;
	char *mero = NULL;
Thomas White's avatar
Thomas White committed
269
	char *expand = NULL;
Thomas White's avatar
Thomas White committed
270
	char *output = NULL;
271
	char *input = NULL;
272
	char *filename = NULL;
Thomas White's avatar
Thomas White committed
273
274
	ReflItemList *input_items;
	ReflItemList *write_items;
275
	UnitCell *cell = NULL;
276
	char *beamfile = NULL;
277
	struct beam_params *beam;  /* Beam parameters for Poisson calculation */
278
279
280
281

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
Thomas White's avatar
Thomas White committed
282
		{"template",           1, NULL,               't'},
283
284
		{"poisson",            0, &config_poisson,     1},
		{"noise",              0, &config_noise,       1},
Thomas White's avatar
Thomas White committed
285
		{"output",             1, NULL,               'o'},
286
		{"symmetry",           1, NULL,               'y'},
Thomas White's avatar
Thomas White committed
287
288
		{"twin",               1, NULL,               'w'},
		{"expand",             1, NULL,               'e'},
289
		{"intensities",        1, NULL,               'i'},
290
		{"multiplicity",       0, &config_multi,       1},
291
		{"beam",               1, NULL,               'b'},
292
293
294
295
		{0, 0, NULL, 0}
	};

	/* Short options */
296
	while ((c = getopt_long(argc, argv, "ht:o:i:w:y:e:b:",
Thomas White's avatar
Thomas White committed
297
	                        longopts, NULL)) != -1) {
298
299

		switch (c) {
Thomas White's avatar
Thomas White committed
300
		case 'h' :
301
302
303
			show_help(argv[0]);
			return 0;

Thomas White's avatar
Thomas White committed
304
		case 't' :
Thomas White's avatar
Thomas White committed
305
306
307
			template = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
308
		case 'o' :
Thomas White's avatar
Thomas White committed
309
310
311
			output = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
312
		case 'i' :
313
314
315
			input = strdup(optarg);
			break;

316
317
318
319
320
321
322
323
		case 'y' :
			mero = strdup(optarg);
			break;

		case 'w' :
			holo = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
324
325
326
327
		case 'e' :
			expand = strdup(optarg);
			break;

328
329
330
331
		case 'b' :
			beamfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
332
		case 0 :
333
334
			break;

Thomas White's avatar
Thomas White committed
335
		default :
336
337
338
339
340
			return 1;
		}

	}

341
342
343
344
	if ( filename == NULL ) {
		filename = strdup("molecule.pdb");
	}

Thomas White's avatar
Thomas White committed
345
346
347
348
349
350
	if ( (holo != NULL) && (expand != NULL) ) {
		ERROR("You cannot 'twin' and 'expand' at the same time.\n");
		ERROR("Decide which one you want to do first.\n");
		exit(1);
	}

351
	cell = load_cell_from_pdb(filename);
352
353
354
355
356
	if ( !config_nophase ) {
		phases = new_list_phase();
	} else {
		phases = NULL;
	}
357
	esds = new_list_sigma();
358

359
360
361
362
363
364
365
366
	ideal_ref = new_list_intensity();
	input_items = read_reflections(input, ideal_ref, phases,
	                               NULL, esds);
	free(input);
	if ( check_symmetry(input_items, mero) ) {
		ERROR("The input reflection list does not appear to"
		      " have symmetry %s\n", mero);
		return 1;
367
	}
368

369
370
	if ( config_poisson ) poisson_reflections(ideal_ref, input_items);
	if ( config_noise ) noise_reflections(ideal_ref, input_items);
Thomas White's avatar
Thomas White committed
371

372
373
374
	if ( holo != NULL ) {
		ReflItemList *new;
		STATUS("Twinning from %s into %s\n", mero, holo);
375
376
		new = twin_reflections(ideal_ref, input_items,
		                       holo, mero, esds);
377
378
		delete_items(input_items);
		input_items = new;
Thomas White's avatar
Thomas White committed
379
380
	}

Thomas White's avatar
Thomas White committed
381
382
383
384
385
386
387
388
	if ( expand != NULL ) {
		ReflItemList *new;
		STATUS("Expanding from %s into %s\n", mero, expand);
		new = expand_reflections(ideal_ref, input_items, expand, mero);
		delete_items(input_items);
		input_items = new;
	}

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
	if ( config_multi ) {

		int i;

		for ( i=0; i<num_items(input_items); i++ ) {

			struct refl_item *it;
			double inty;

			it = get_item(input_items, i);
			inty = lookup_intensity(ideal_ref, it->h, it->k, it->l);
			inty *= num_equivs(it->h, it->k, it->l, mero);
			set_intensity(ideal_ref, it->h, it->k, it->l, inty);
			STATUS("%i %i %i %i\n", it->h, it->k, it->l,
			       num_equivs(it->h, it->k, it->l, mero));

		}
	}

Thomas White's avatar
Thomas White committed
408
409
410
411
	if ( template ) {
		/* Write out only reflections which are in the template
		 * (and which we have in the input) */
		ReflItemList *template_items;
412
413
		template_items = read_reflections(template,
		                                  NULL, NULL, NULL, NULL);
Thomas White's avatar
Thomas White committed
414
415
416
417
418
		write_items = intersection_items(input_items, template_items);
		delete_items(template_items);
	} else {
		/* Write out all reflections */
		write_items = new_items();
Thomas White's avatar
Thomas White committed
419
		/* (quick way of copying a list) */
Thomas White's avatar
Thomas White committed
420
421
422
		union_items(write_items, input_items);
	}

423
	write_reflections(output, write_items, ideal_ref, esds, phases,
424
	                  NULL, cell);
Thomas White's avatar
Thomas White committed
425
426
427

	delete_items(input_items);
	delete_items(write_items);
428
429
430

	return 0;
}