render_hkl.c 10.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*
 * render_hkl.c
 *
 * Draw pretty renderings of reflection lists
 *
 * (c) 2006-2010 Thomas White <taw@physics.org>
 *
 * 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>
23
#ifdef HAVE_CAIRO
Thomas White's avatar
Thomas White committed
24
25
#include <cairo.h>
#include <cairo-pdf.h>
26
#endif
27
28
29

#include "utils.h"
#include "reflections.h"
30
#include "povray.h"
31
#include "symmetry.h"
32
#include "render.h"
33

34
35
36
37
enum {
	WGHT_I,
	WGHT_SQRTI,
	WGHT_COUNTS,
38
	WGHT_RAWCOUNTS,
39
};
40

41
42
43
44
static void show_help(const char *s)
{
	printf("Syntax: %s [options] <file.hkl>\n\n", s);
	printf(
45
"Render intensity lists in various ways.\n"
46
"\n"
47
48
"  -h, --help              Display this help message.\n"
"      --povray            Render a 3D animation using POV-ray.\n"
49
#ifdef HAVE_CAIRO
50
"      --zone-axis         Render a 2D zone axis pattern.\n"
51
#endif
52
53
54
55
56
57
"      --boost=<val>       Squash colour scale by <val>.\n"
"  -j <n>                  Run <n> instances of POV-ray in parallel.\n"
"  -p, --pdb=<file>        PDB file from which to get the unit cell.\n"
"  -y, --symmetry=<sym>    Expand reflections according to point group <sym>.\n"
"  -w  --weighting=<wght>  Colour/shade the reciprocal lattice points\n"
"                           according to:\n"
58
59
60
61
62
63
"                            I      : the intensity of the reflection.\n"
"                            sqrtI  : the square root of the intensity.\n"
"                            count  : the number of hits for the reflection.\n"
"                                     (after correcting for 'epsilon')\n"
"                            rawcts : the raw number of hits for the\n"
"                                     reflection (no 'epsilon' correction).\n"
64
);
65
66
67
}


68
#ifdef HAVE_CAIRO
69
static void render_za(UnitCell *cell, double *ref, unsigned int *c,
70
                      double boost, const char *sym, int wght, int colscale)
71
{
Thomas White's avatar
Thomas White committed
72
73
	cairo_surface_t *surface;
	cairo_t *dctx;
74
	double max_u, max_v, max_res, max_val;
75
	double scale_u, scale_v, scale;
Thomas White's avatar
Thomas White committed
76
	double sep_u, sep_v, max_r;
77
78
	double u, v;
	signed int max_h, max_k;
Thomas White's avatar
Thomas White committed
79
	double as, bs, theta;
80
81
82
	double asx, asy, asz;
	double bsx, bsy, bsz;
	double csx, csy, csz;
Thomas White's avatar
Thomas White committed
83
84
	signed int h, k;
	float wh, ht;
85

Thomas White's avatar
Thomas White committed
86
87
	wh = 1024;
	ht = 1024;
88

Thomas White's avatar
Thomas White committed
89
	surface = cairo_pdf_surface_create("za.pdf", wh, ht);
90

Thomas White's avatar
Thomas White committed
91
92
93
94
95
	if ( cairo_surface_status(surface) != CAIRO_STATUS_SUCCESS ) {
		fprintf(stderr, "Couldn't create Cairo surface\n");
		cairo_surface_destroy(surface);
		return;
	}
96

Thomas White's avatar
Thomas White committed
97
	dctx = cairo_create(surface);
98

Thomas White's avatar
Thomas White committed
99
100
101
102
	/* Black background */
	cairo_rectangle(dctx, 0.0, 0.0, wh, ht);
	cairo_set_source_rgb(dctx, 0.0, 0.0, 0.0);
	cairo_fill(dctx);
103

104
	max_u = 0.0;  max_v = 0.0;  max_val = 0.0;
105
	max_res = 0.0;  max_h = 0;  max_k = 0;
Thomas White's avatar
Thomas White committed
106
107

	/* Work out reciprocal lattice spacings and angles for this cut */
108
	if ( cell_get_reciprocal(cell, &asx, &asy, &asz,
Thomas White's avatar
Thomas White committed
109
	                          &bsx, &bsy, &bsz,
110
111
112
113
	                          &csx, &csy, &csz) ) {
		ERROR("Couldn't get reciprocal parameters\n");
		return;
	}
Thomas White's avatar
Thomas White committed
114
115
116
117
118
119
120
121
	theta = angle_between(asx, asy, asz, bsx, bsy, bsz);
	as = modulus(asx, asy, asz) / 1e9;
	bs = modulus(bsx, bsy, bsz) / 1e9;
	STATUS("theta=%f\n", rad2deg(theta));

	for ( h=-INDMAX; h<INDMAX; h++ ) {
	for ( k=-INDMAX; k<INDMAX; k++ ) {

122
		double u, v, val, res;
Thomas White's avatar
Thomas White committed
123
		int ct;
124
		int nequiv, p;
Thomas White's avatar
Thomas White committed
125
126
127
128

		ct = lookup_count(c, h, k, 0);
		if ( ct < 1 ) continue;

129
130
		switch ( wght ) {
		case WGHT_I :
Thomas White's avatar
Thomas White committed
131
			val = lookup_intensity(ref, h, k, 0);
132
133
			break;
		case WGHT_SQRTI :
Thomas White's avatar
Thomas White committed
134
			val = lookup_intensity(ref, h, k, 0);
135
136
137
			val = (val>0.0) ? sqrt(val) : 0.0;
			break;
		case WGHT_COUNTS :
138
139
140
141
			val = (float)ct;
			val /= (float)num_equivs(h, k, 0, sym);
			break;
		case WGHT_RAWCOUNTS :
142
143
			val = (float)ct;
			break;
Thomas White's avatar
Thomas White committed
144
145
146
		default :
			ERROR("Invalid weighting.\n");
			abort();
Thomas White's avatar
Thomas White committed
147
		}
148

149
150
151
152
153
154
155
156
157
158
159
160
		nequiv = num_equivs(h, k, 0, sym);
		for ( p=0; p<nequiv; p++ ) {

			signed int he, ke, le;
			get_equiv(h, k, 0, &he, &ke, &le, sym, p);

			u =  (double)he*as*sin(theta);
			v =  (double)he*as*cos(theta) + ke*bs;
			if ( fabs(u) > fabs(max_u) ) max_u = fabs(u);
			if ( fabs(v) > fabs(max_v) ) max_v = fabs(v);
			if ( fabs(val) > fabs(max_val) ) {
				max_val = fabs(val);
161
			}
162
163
164
165
166
			if ( fabs(he) > max_h ) max_h = fabs(he);
			if ( fabs(ke) > max_k ) max_k = fabs(ke);
			res = resolution(cell, he, ke, 0);
			if ( res > max_res ) max_res = res;

167
168
169
		}

	}
Thomas White's avatar
Thomas White committed
170
	}
171

Thomas White's avatar
Thomas White committed
172
	max_res /= 1e9;
173
174
	printf("Maximum resolution is 1/d = %5.3f nm^-1, d = %5.3f nm\n",
	       max_res*2.0, 1.0/(max_res*2.0));
Thomas White's avatar
Thomas White committed
175

176
	if ( max_val <= 0.0 ) {
Thomas White's avatar
Thomas White committed
177
178
		max_r = 4.0;
		goto out;
179
180
	}

Thomas White's avatar
Thomas White committed
181
	/* Choose whichever scaling factor gives the smallest value */
182
183
184
	scale_u = ((double)(wh/2.0)-50.0) / max_u;
	scale_v = ((double)(ht/2.0)-50.0) / max_v;
	scale = (scale_u < scale_v) ? scale_u : scale_v;
185

Thomas White's avatar
Thomas White committed
186
187
	sep_u = as * scale * cos(theta);
	sep_v = bs * scale;
188
189
	max_r = (sep_u < sep_v) ? sep_u : sep_v;
	max_r -= 1.0;  /* Add a tiny separation between circles */
Thomas White's avatar
Thomas White committed
190
191
192
193

	for ( h=-INDMAX; h<INDMAX; h++ ) {
	for ( k=-INDMAX; k<INDMAX; k++ ) {

194
		double u, v, val;
Thomas White's avatar
Thomas White committed
195
		int ct;
196
		int nequiv, p;
Thomas White's avatar
Thomas White committed
197
198

		ct = lookup_count(c, h, k, 0);
199
		if ( ct < 1 ) continue;  /* Must have at least one count */
Thomas White's avatar
Thomas White committed
200

201
202
203
204
205
206
207
208
209
		switch ( wght ) {
		case WGHT_I :
			val = lookup_intensity(ref, h, k, 0) / (float)ct;
			break;
		case WGHT_SQRTI :
			val = lookup_intensity(ref, h, k, 0) / (float)ct;
			val = (val>0.0) ? sqrt(val) : 0.0;
			break;
		case WGHT_COUNTS :
210
211
212
213
			val = (float)ct;
			val /= (float)num_equivs(h, k, 0, sym);
			break;
		case WGHT_RAWCOUNTS :
214
215
			val = (float)ct;
			break;
Thomas White's avatar
Thomas White committed
216
217
218
		default :
			ERROR("Invalid weighting.\n");
			abort();
Thomas White's avatar
Thomas White committed
219
		}
220

221
222
223
224
		nequiv = num_equivs(h, k, 0, sym);
		for ( p=0; p<nequiv; p++ ) {

			signed int he, ke, le;
225
			float r, g, b;
226
227
228
229
			get_equiv(h, k, 0, &he, &ke, &le, sym, p);

			u = (double)he*as*sin(theta);
			v = (double)he*as*cos(theta) + ke*bs;
Thomas White's avatar
Thomas White committed
230

231
232
			cairo_arc(dctx, ((double)wh/2)+u*scale,
					((double)ht/2)+v*scale, max_r,
233
					0, 2*M_PI);
Thomas White's avatar
Thomas White committed
234

235
236
			render_scale(val, max_val/boost, colscale, &r, &g, &b);
			cairo_set_source_rgb(dctx, r, g, b);
237
238
239
			cairo_fill(dctx);

		}
Thomas White's avatar
Thomas White committed
240
241

	}
242
243
	}

Thomas White's avatar
Thomas White committed
244
245
246
247
248
249
250
out:
	/* Centre marker */
	cairo_arc(dctx, (double)wh/2,
			(double)ht/2, max_r, 0, 2*M_PI);
	cairo_set_source_rgb(dctx, 1.0, 0.0, 0.0);
	cairo_fill(dctx);

251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
	/* Draw indexing lines */
	cairo_set_line_width(dctx, 4.0);
	cairo_move_to(dctx, (double)wh/2, (double)ht/2);
	u = (double)max_h*as*sin(theta);
	v = (double)max_h*as*cos(theta) + 0*bs;
	cairo_line_to(dctx, ((double)wh/2)+u*scale,
	                    ((double)ht/2)+v*scale);
	cairo_set_source_rgb(dctx, 0.0, 1.0, 0.0);
	cairo_stroke(dctx);

	cairo_move_to(dctx,((double)wh/2)+u*scale-40.0,
	                   ((double)ht/2)+v*scale+40.0);
	                   cairo_set_font_size(dctx, 40.0);
	cairo_show_text(dctx, "h");
	cairo_fill(dctx);

	cairo_move_to(dctx, (double)wh/2, (double)ht/2);
	u = 0.0;
	v = (double)max_k*bs;
	cairo_line_to(dctx, ((double)wh/2)+u*scale,
	                    ((double)ht/2)+v*scale);
	cairo_set_source_rgb(dctx, 0.0, 1.0, 0.0);
	cairo_stroke(dctx);

	cairo_move_to(dctx,((double)wh/2)+u*scale-40.0,
	                   ((double)ht/2)+v*scale-40.0);
	                   cairo_set_font_size(dctx, 40.0);
	cairo_show_text(dctx, "k");
	cairo_fill(dctx);

Thomas White's avatar
Thomas White committed
281
282
283
	cairo_surface_finish(surface);
	cairo_destroy(dctx);
}
284
#endif
Thomas White's avatar
Thomas White committed
285
286
287
288
289
290
291
292
293
294


int main(int argc, char *argv[])
{
	int c;
	UnitCell *cell;
	char *infile;
	double *ref;
	int config_povray = 0;
	int config_zoneaxis = 0;
Thomas White's avatar
Thomas White committed
295
	int config_sqrt = 0;
Thomas White's avatar
Thomas White committed
296
	unsigned int nproc = 1;
297
	char *pdb = NULL;
298
	int r = 0;
299
	double boost = 1.0;
300
	char *sym = NULL;
301
302
	char *weighting = NULL;
	int wght;
303
304
	int colscale;
	char *cscale = NULL;
Thomas White's avatar
Thomas White committed
305
	unsigned int *cts;
Thomas White's avatar
Thomas White committed
306
307
308
309
310
311

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
		{"povray",             0, &config_povray,      1},
		{"zone-axis",          0, &config_zoneaxis,    1},
312
		{"pdb",                1, NULL,               'p'},
313
		{"boost",              1, NULL,               'b'},
314
		{"symmetry",           1, NULL,               'y'},
315
		{"weighting",          1, NULL,               'w'},
316
		{"colscale",           1, NULL,               'c'},
317
		{"counts",             0, &config_sqrt,        1},
Thomas White's avatar
Thomas White committed
318
319
320
321
		{0, 0, NULL, 0}
	};

	/* Short options */
322
323
	while ((c = getopt_long(argc, argv, "hj:p:w:c:y:",
	                        longopts, NULL)) != -1) {
Thomas White's avatar
Thomas White committed
324
325

		switch (c) {
Thomas White's avatar
Thomas White committed
326
		case 'h' :
Thomas White's avatar
Thomas White committed
327
328
329
			show_help(argv[0]);
			return 0;

Thomas White's avatar
Thomas White committed
330
		case 'j' :
Thomas White's avatar
Thomas White committed
331
332
333
			nproc = atoi(optarg);
			break;

334
335
336
337
		case 'p' :
			pdb = strdup(optarg);
			break;

338
339
340
341
		case 'b' :
			boost = atof(optarg);
			break;

342
343
344
345
		case 'y' :
			sym = strdup(optarg);
			break;

346
347
348
349
		case 'w' :
			weighting = strdup(optarg);
			break;

350
351
352
353
		case 'c' :
			cscale = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
354
		case 0 :
Thomas White's avatar
Thomas White committed
355
356
			break;

Thomas White's avatar
Thomas White committed
357
		default :
Thomas White's avatar
Thomas White committed
358
359
360
361
362
			return 1;
		}

	}

363
364
365
366
	if ( pdb == NULL ) {
		pdb = strdup("molecule.pdb");
	}

367
368
369
370
	if ( sym == NULL ) {
		sym = strdup("1");
	}

371
372
373
374
375
376
377
378
379
380
	if ( weighting == NULL ) {
		weighting = strdup("I");
	}

	if ( strcmp(weighting, "I") == 0 ) {
		wght = WGHT_I;
	} else if ( strcmp(weighting, "sqrtI") == 0 ) {
		wght = WGHT_SQRTI;
	} else if ( strcmp(weighting, "count") == 0 ) {
		wght = WGHT_COUNTS;
381
382
	} else if ( strcmp(weighting, "counts") == 0 ) {
		wght = WGHT_COUNTS;
383
384
	} else if ( strcmp(weighting, "rawcts") == 0 ) {
		wght = WGHT_RAWCOUNTS;
385
386
387
388
	} else if ( strcmp(weighting, "rawcount") == 0 ) {
		wght = WGHT_RAWCOUNTS;
	} else if ( strcmp(weighting, "rawcounts") == 0 ) {
		wght = WGHT_RAWCOUNTS;
389
390
391
392
	} else {
		ERROR("Unrecognised weighting '%s'\n", weighting);
		return 1;
	}
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
	free(weighting);

	if ( cscale == NULL ) {
		cscale = strdup("mono");
	}

	if ( strcmp(cscale, "mono") == 0 ) {
		colscale = SCALE_MONO;
	} else if ( strcmp(cscale, "invmono") == 0 ) {
		colscale = SCALE_INVMONO;
	} else if ( strcmp(cscale, "colour") == 0 ) {
		colscale = SCALE_COLOUR;
	} else if ( strcmp(cscale, "color") == 0 ) {
		colscale = SCALE_COLOUR;
	} else {
		ERROR("Unrecognised colour scale '%s'\n", cscale);
		return 1;
	}
	free(cscale);
412

Thomas White's avatar
Thomas White committed
413
414
	infile = argv[optind];

415
	cell = load_cell_from_pdb(pdb);
416
417
418
419
	if ( cell == NULL ) {
		ERROR("Couldn't load unit cell from %s\n", pdb);
		return 1;
	}
Thomas White's avatar
Thomas White committed
420
	ref = new_list_intensity();
Thomas White's avatar
Thomas White committed
421
	cts = new_list_count();
Thomas White's avatar
Thomas White committed
422
423
	ReflItemList *items = read_reflections(infile, ref, NULL, cts);
	delete_items(items);
Thomas White's avatar
Thomas White committed
424
425
426
427
428
429
	if ( ref == NULL ) {
		ERROR("Couldn't open file '%s'\n", infile);
		return 1;
	}

	if ( config_povray ) {
430
		r = povray_render_animation(cell, ref, cts, nproc);
Thomas White's avatar
Thomas White committed
431
	} else if ( config_zoneaxis ) {
432
#ifdef HAVE_CAIRO
433
		render_za(cell, ref, cts, boost, sym, wght, colscale);
434
435
436
437
438
#else
		ERROR("This version of CrystFEL was compiled without Cairo");
		ERROR(" support, which is required to plot a zone axis");
		ERROR(" pattern.  Sorry!\n");
#endif
Thomas White's avatar
Thomas White committed
439
440
441
442
	} else {
		ERROR("Try again with either --povray or --zone-axis.\n");
	}

443
	free(pdb);
444
	free(sym);
445

446
	return r;
447
}