indexamajig.c 28.9 KB
Newer Older
Thomas White's avatar
Thomas White committed
1
/*
2
 * indexamajig.c
Thomas White's avatar
Thomas White committed
3
 *
Thomas White's avatar
Thomas White committed
4
 * Index patterns, output hkl+intensity etc.
Thomas White's avatar
Thomas White committed
5
 *
6
7
 * Copyright © 2012 Deutsches Elektronen-Synchrotron DESY,
 *                  a research centre of the Helmholtz Association.
8
9
 * Copyright © 2012 Richard Kirian
 * Copyright © 2012 Lorenzo Galli
10
11
 *
 * Authors:
12
13
14
 *   2010-2012 Thomas White <taw@physics.org>
 *   2011      Richard Kirian
 *   2012      Lorenzo Galli
Thomas White's avatar
Thomas White committed
15
 *
Thomas White's avatar
Thomas White committed
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 * 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/>.
Thomas White's avatar
Thomas White committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 *
 */


#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>
Thomas White's avatar
Thomas White committed
44
#include <hdf5.h>
Thomas White's avatar
Thomas White committed
45
#include <gsl/gsl_errno.h>
46
#include <pthread.h>
47
48

#ifdef HAVE_CLOCK_GETTIME
49
#include <time.h>
50
51
52
#else
#include <sys/time.h>
#endif
Thomas White's avatar
Thomas White committed
53
54
55

#include "utils.h"
#include "hdf5-file.h"
Thomas White's avatar
Thomas White committed
56
#include "index.h"
57
#include "peaks.h"
58
#include "detector.h"
Thomas White's avatar
Thomas White committed
59
#include "filters.h"
60
#include "thread-pool.h"
61
#include "beam-parameters.h"
62
#include "geometry.h"
Thomas White's avatar
Thomas White committed
63
#include "stream.h"
Thomas White's avatar
Thomas White committed
64
#include "reflist-utils.h"
65

66

Thomas White's avatar
Thomas White committed
67
/* Write statistics at APPROXIMATELY this interval */
68
69
70
#define STATS_EVERY_N_SECONDS (5)


71
72
73
74
75
76
enum {
	PEAK_ZAEF,
	PEAK_HDF5,
};


77
78
/* Information about the indexing process which is common to all patterns */
struct static_index_args
79
80
81
82
83
{
	UnitCell *cell;
	int config_cmfilter;
	int config_noisefilter;
	int config_verbose;
Thomas White's avatar
Thomas White committed
84
	int stream_flags;         /* What goes into the output? */
85
	int config_satcorr;
86
	int config_closer;
87
	int config_insane;
88
	int config_bgsub;
89
	float threshold;
90
	float min_gradient;
91
	float min_snr;
92
	double min_int_snr;
Thomas White's avatar
Thomas White committed
93
	struct detector *det;
Thomas White's avatar
Thomas White committed
94
95
	IndexingMethod *indm;
	IndexingPrivate **ipriv;
Thomas White's avatar
Thomas White committed
96
	int peaks;                /* Peak detection method */
97
	int cellr;
98
	float tols[4];
99
	struct beam_params *beam;
Thomas White's avatar
Thomas White committed
100
	const char *element;
101
	const char *hdf5_peak_path;
102
103
104
	double ir_inn;
	double ir_mid;
	double ir_out;
105

106
107
108
	/* Output stream */
	pthread_mutex_t *output_mutex;  /* Protects the output stream */
	FILE *ofh;
109
	const struct copy_hdf5_field *copyme;
110
111
112
};


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/* Information about the indexing process for one pattern */
struct index_args
{
	/* "Input" */
	char *filename;
	struct static_index_args static_args;

	/* "Output" */
	int indexable;
};


/* Information needed to choose the next task and dispatch it */
struct queue_args
{
	FILE *fh;
	char *prefix;
130
	int config_basename;
131
132
	struct static_index_args static_args;

133
	char *use_this_one_instead;
134
135
136
137
138
139

	int n_indexable;
	int n_processed;
	int n_indexable_last_stats;
	int n_processed_last_stats;
	int t_last_stats;
140
141
142
};


Thomas White's avatar
Thomas White committed
143
144
145
146
147
148
static void show_help(const char *s)
{
	printf("Syntax: %s [options]\n\n", s);
	printf(
"Process and index FEL diffraction images.\n"
"\n"
149
" -h, --help               Display this help message.\n"
Thomas White's avatar
Thomas White committed
150
"\n"
151
" -i, --input=<filename>   Specify file containing list of images to process.\n"
Thomas White's avatar
Thomas White committed
152
"                           '-' means stdin, which is the default.\n"
Thomas White's avatar
Thomas White committed
153
154
" -o, --output=<filename>  Write output stream to this file. '-' for stdout.\n"
"                           Default: indexamajig.stream\n"
Thomas White's avatar
Thomas White committed
155
"\n"
Thomas White's avatar
Thomas White committed
156
157
158
159
160
"     --indexing=<methods> Use 'methods' for indexing.  Provide one or more\n"
"                           methods separated by commas.  Choose from:\n"
"                            none     : no indexing (default)\n"
"                            dirax    : invoke DirAx\n"
"                            mosflm   : invoke MOSFLM (DPS)\n"
Thomas White's avatar
Thomas White committed
161
"                            reax     : DPS algorithm with known unit cell\n"
162
" -g. --geometry=<file>    Get detector geometry from file.\n"
163
164
165
" -b, --beam=<file>        Get beam parameters from file (provides nominal\n"
"                           wavelength value if no per-shot value is found in\n"
"                           the HDF5 files.\n"
166
" -p, --pdb=<file>         PDB file from which to get the unit cell to match.\n"
Thomas White's avatar
Thomas White committed
167
"                           Default: 'molecule.pdb'.\n"
168
"     --basename           Remove the directory parts of the filenames.\n"
169
" -x, --prefix=<p>         Prefix filenames from input file with <p>.\n"
170
171
172
"     --peaks=<method>     Use 'method' for finding peaks.  Choose from:\n"
"                           zaef  : Use Zaefferer (2000) gradient detection.\n"
"                                    This is the default method.\n"
173
174
175
"                           hdf5  : Get from a table in HDF5 file.\n"
"     --hdf5-peaks=<p>     Find peaks table in HDF5 file here.\n"
"                           Default: /processing/hitfinder/peakinfo\n"
Thomas White's avatar
Thomas White committed
176
177
"\n\n"
"You can control what information is included in the output stream using\n"
Thomas White's avatar
Thomas White committed
178
"' --record=<flag1>,<flag2>,<flag3>' and so on.  Possible flags are:\n\n"
179
180
" integrated        Include a list of reflection intensities, produced by\n"
"                    integrating around predicted peak locations.\n"
Thomas White's avatar
Thomas White committed
181
"\n"
182
183
" peaks             Include peak locations and intensities from the peak\n"
"                    search.\n"
Thomas White's avatar
Thomas White committed
184
"\n"
185
" peaksifindexed    As 'peaks', but only if the pattern could be indexed.\n"
Thomas White's avatar
Thomas White committed
186
"\n"
187
188
" peaksifnotindexed As 'peaks', but only if the pattern could NOT be indexed.\n"
"\n\n"
Thomas White's avatar
Thomas White committed
189
"The default is '--record=integrated'.\n"
Thomas White's avatar
Thomas White committed
190
191
"\n\n"
"For more control over the process, you might need:\n\n"
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
"  --cell-reduction=<m>  Use <m> as the cell reduction method. Choose from:\n"
"                         none    : no matching, just use the raw cell.\n"
"                         reduce  : full cell reduction.\n"
"                         compare : match by at most changing the order of\n"
"                                   the indices.\n"
"                         compare_ab : compare 'a' and 'b' lengths only.\n"
"    --tolerance=<tol>   Set the tolerances for cell reduction.\n"
"                          Default: 5,5,5,1.5.\n"
"    --filter-cm         Perform common-mode noise subtraction on images\n"
"                         before proceeding.  Intensities will be extracted\n"
"                         from the image as it is after this processing.\n"
"    --filter-noise      Apply an aggressive noise filter which sets all\n"
"                         pixels in each 3x3 region to zero if any of them\n"
"                         have negative values.  Intensity measurement will\n"
"                         be performed on the image as it was before this.\n"
"    --no-sat-corr       Don't correct values of saturated peaks using a\n"
"                         table included in the HDF5 file.\n"
"    --threshold=<n>     Only accept peaks above <n> ADU.  Default: 800.\n"
"    --min-gradient=<n>  Minimum gradient for Zaefferer peak search.\n"
"                         Default: 100,000.\n"
"    --min-snr=<n>       Minimum signal-to-noise ratio for peaks.\n"
"                         Default: 5.\n"
"    --min-integration-snr=<n> Minimum signal-to-noise ratio for peaks\n"
"                         during integration. Default: -infinity.\n"
"    --int-radius=<r>    Set the integration radii.  Default: 4,5,7.\n"
"-e, --image=<element>   Use this image from the HDF5 file.\n"
"                          Example: /data/data0.\n"
"                          Default: The first one found.\n"
Thomas White's avatar
Thomas White committed
220
"\n"
221
222
223
224
"\nFor time-resolved stuff, you might want to use:\n\n"
"     --copy-hdf5-field <f>  Copy the value of field <f> into the stream. You\n"
"                             can use this option as many times as you need.\n"
"\n"
225
226
227
"\nOptions for greater performance or verbosity:\n\n"
"     --verbose            Be verbose about indexing.\n"
" -j <n>                   Run <n> analyses in parallel.  Default 1.\n"
228
229
230
"\n"
"\nOptions you probably won't need:\n\n"
"     --no-check-prefix    Don't attempt to correct the --prefix.\n"
231
232
233
"     --no-closer-peak     Don't integrate from the location of a nearby peak\n"
"                           instead of the position closest to the reciprocal\n"
"                           lattice point.\n"
234
235
"     --insane             Don't check that the reduced cell accounts for at\n"
"                           least 10%% of the located peaks.\n"
236
237
"     --no-bg-sub          Don't subtract local background estimates from\n"
"                           integrated intensities.\n"
238
"\n"
Thomas White's avatar
Thomas White committed
239
240
"\nYou can tune the CPU affinities for enhanced performance on NUMA machines:\n"
"\n"
Thomas White's avatar
Thomas White committed
241
242
"     --cpus=<n>           Specify number of CPUs.  This is NOT the same as\n"
"                           giving the number of analyses to run in parallel.\n"
243
244
"     --cpugroup=<n>       Batch threads in groups of this size.\n"
"     --cpuoffset=<n>      Start using CPUs at this group number.\n"
Thomas White's avatar
Thomas White committed
245
);
Thomas White's avatar
Thomas White committed
246
247
248
}


249
static void process_image(void *pp, int cookie)
250
{
251
	struct index_args *pargs = pp;
252
253
254
255
	struct hdfile *hdfile;
	struct image image;
	float *data_for_measurement;
	size_t data_size;
256
	char *filename = pargs->filename;
257
258
259
260
	UnitCell *cell = pargs->static_args.cell;
	int config_cmfilter = pargs->static_args.config_cmfilter;
	int config_noisefilter = pargs->static_args.config_noisefilter;
	int config_verbose = pargs->static_args.config_verbose;
Thomas White's avatar
Thomas White committed
261
	IndexingMethod *indm = pargs->static_args.indm;
262
	struct beam_params *beam = pargs->static_args.beam;
263
264
265

	image.features = NULL;
	image.data = NULL;
Thomas White's avatar
Thomas White committed
266
	image.flags = NULL;
267
	image.indexed_cell = NULL;
268
	image.id = cookie;
269
	image.filename = filename;
270
	image.det = copy_geom(pargs->static_args.det);
271
	image.copyme = pargs->static_args.copyme;
272
273
274
275
276
277
278
	image.beam = beam;

	if ( beam == NULL ) {
		ERROR("Warning: no beam parameters file.\n");
		ERROR("I'm going to assume 1 ADU per photon, which is almost");
		ERROR(" certainly wrong.  Peak sigmas will be incorrect.\n");
	}
279

Thomas White's avatar
Thomas White committed
280
	pargs->indexable = 0;
281

282
	hdfile = hdfile_open(filename);
Thomas White's avatar
Thomas White committed
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
	if ( hdfile == NULL ) return;

	if ( pargs->static_args.element != NULL ) {

		int r;
		r = hdfile_set_image(hdfile, pargs->static_args.element);
		if ( r ) {
			ERROR("Couldn't select path '%s'\n",
			      pargs->static_args.element);
			hdfile_close(hdfile);
			return;
		}

	} else {

		int r;
		r = hdfile_set_first_image(hdfile, "/");
		if ( r ) {
			ERROR("Couldn't select first path\n");
			hdfile_close(hdfile);
			return;
		}

306
307
	}

308
	hdf5_read(hdfile, &image, pargs->static_args.config_satcorr);
309
310
311
312
313
314
315
316
317
318
319
320
321
322

	if ( (image.width != image.det->max_fs+1)
	  || (image.height != image.det->max_ss+1) )
	{
		ERROR("Image size doesn't match geometry size"
		      " - rejecting image.\n");
		ERROR("Image size: %i,%i.  Geometry size: %i,%i\n",
		      image.width, image.height,
		      image.det->max_fs+1, image.det->max_ss+1);
		hdfile_close(hdfile);
		free_detector_geometry(image.det);
		return;
	}

323
324
	if ( image.lambda < 0.0 ) {
		if ( beam != NULL ) {
Thomas White's avatar
Thomas White committed
325
			ERROR("Using nominal photon energy of %.2f eV\n",
326
                              beam->photon_energy);
Thomas White's avatar
Thomas White committed
327
328
			image.lambda = ph_en_to_lambda(
			                          eV_to_J(beam->photon_energy));
329
330
331
332
		} else {
			ERROR("No wavelength in file, so you need to give "
			      "a beam parameters file with -b.\n");
			hdfile_close(hdfile);
Thomas White's avatar
Thomas White committed
333
			free_detector_geometry(image.det);
334
335
336
			return;
		}
	}
337
	fill_in_values(image.det, hdfile);
338
339
340
341
342
343
344
345
346
347
348
349
350

	if ( config_cmfilter ) {
		filter_cm(&image);
	}

	/* Take snapshot of image after CM subtraction but before
	 * the aggressive noise filter. */
	data_size = image.width*image.height*sizeof(float);
	data_for_measurement = malloc(data_size);

	if ( config_noisefilter ) {
		filter_noise(&image, data_for_measurement);
	} else {
351
		memcpy(data_for_measurement, image.data, data_size);
352
353
	}

354
	switch ( pargs->static_args.peaks )
355
356
357
	{
	case PEAK_HDF5 :
		/* Get peaks from HDF5 */
358
359
360
		if ( get_peaks(&image, hdfile,
		               pargs->static_args.hdf5_peak_path) )
		{
361
362
363
364
			ERROR("Failed to get peaks from HDF5 file.\n");
		}
		break;
	case PEAK_ZAEF :
365
		search_peaks(&image, pargs->static_args.threshold,
366
		             pargs->static_args.min_gradient,
367
368
369
370
		             pargs->static_args.min_snr,
		             pargs->static_args.ir_inn,
		             pargs->static_args.ir_mid,
		             pargs->static_args.ir_out);
371
372
		break;
	}
Thomas White's avatar
Thomas White committed
373
374
375
376
377
378

	/* Get rid of noise-filtered version at this point
	 * - it was strictly for the purposes of peak detection. */
	free(image.data);
	image.data = data_for_measurement;

379
	/* Calculate orientation matrix (by magic) */
380
381
382
	image.div = beam->divergence;
	image.bw = beam->bandwidth;
	image.profile_radius = 0.0001e9;
383
	index_pattern(&image, cell, indm, pargs->static_args.cellr,
384
		      config_verbose, pargs->static_args.ipriv,
385
		      pargs->static_args.config_insane, pargs->static_args.tols);
386

387
	if ( image.indexed_cell != NULL ) {
Thomas White's avatar
Thomas White committed
388

389
		pargs->indexable = 1;
390

391
392
		image.reflections = find_intersections(&image,
		                                       image.indexed_cell);
393

394
		if ( image.reflections != NULL ) {
395

396
			integrate_reflections(&image,
397
					      pargs->static_args.config_closer,
398
					      pargs->static_args.config_bgsub,
399
400
401
402
					      pargs->static_args.min_int_snr,
					      pargs->static_args.ir_inn,
					      pargs->static_args.ir_mid,
					      pargs->static_args.ir_out);
403

404
		}
405

406
407
408
409
410
	} else {

		image.reflections = NULL;

	}
Thomas White's avatar
Thomas White committed
411
412

	pthread_mutex_lock(pargs->static_args.output_mutex);
413
	write_chunk(pargs->static_args.ofh, &image, hdfile,
Thomas White's avatar
Thomas White committed
414
415
	            pargs->static_args.stream_flags);
	pthread_mutex_unlock(pargs->static_args.output_mutex);
416
417

	/* Only free cell if found */
418
	cell_free(image.indexed_cell);
419

Thomas White's avatar
Thomas White committed
420
	reflist_free(image.reflections);
421
	free(image.data);
Thomas White's avatar
Thomas White committed
422
	if ( image.flags != NULL ) free(image.flags);
423
424
	image_feature_list_free(image.features);
	hdfile_close(hdfile);
Thomas White's avatar
Thomas White committed
425
	free_detector_geometry(image.det);
426
427
428
}


429
static void *get_image(void *qp)
430
{
431
	char *line;
432
433
434
	struct index_args *pargs;
	char *rval;
	struct queue_args *qargs = qp;
435

436
	/* Initialise new task arguments */
437
438
439
	pargs = malloc(sizeof(struct index_args));
	memcpy(&pargs->static_args, &qargs->static_args,
	       sizeof(struct static_index_args));
440

441
442
443
	/* Get the next filename */
	if ( qargs->use_this_one_instead != NULL ) {

444
		line = qargs->use_this_one_instead;
445
446
447
448
		qargs->use_this_one_instead = NULL;

	} else {

449
		line = malloc(1024*sizeof(char));
450
		rval = fgets(line, 1023, qargs->fh);
Thomas White's avatar
Thomas White committed
451
452
		if ( rval == NULL ) {
			free(pargs);
Thomas White's avatar
Thomas White committed
453
			free(line);
Thomas White's avatar
Thomas White committed
454
455
			return NULL;
		}
456
457
458
		chomp(line);

	}
459

460
461
462
463
464
465
466
467
468
469
470
471
472
	if ( qargs->config_basename ) {
		char *tmp;
		tmp = safe_basename(line);
		free(line);
		line = tmp;
	}

	pargs->filename = malloc(strlen(qargs->prefix)+strlen(line)+1);

	snprintf(pargs->filename, 1023, "%s%s", qargs->prefix, line);

	free(line);

473
474
	return pargs;
}
475
476


477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
#ifdef HAVE_CLOCK_GETTIME

static time_t get_monotonic_seconds()
{
	struct timespec tp;
	clock_gettime(CLOCK_MONOTONIC, &tp);
	return tp.tv_sec;
}

#else

/* Fallback version of the above.  The time according to gettimeofday() is not
 * monotonic, so measuring intervals based on it will screw up if there's a
 * timezone change (e.g. daylight savings) while the program is running. */
static time_t get_monotonic_seconds()
{
	struct timeval tp;
	gettimeofday(&tp, NULL);
	return tp.tv_sec;
}

#endif

500
501
502
503
static void finalise_image(void *qp, void *pp)
{
	struct queue_args *qargs = qp;
	struct index_args *pargs = pp;
504
	time_t monotonic_seconds;
505

506
	qargs->n_indexable += pargs->indexable;
507
508
	qargs->n_processed++;

509
510
	monotonic_seconds = get_monotonic_seconds();
	if ( monotonic_seconds >= qargs->t_last_stats+STATS_EVERY_N_SECONDS ) {
511
512

		STATUS("%i out of %i indexed so far,"
Thomas White's avatar
Thomas White committed
513
		       " %i out of %i since the last message.\n",
514
515
		       qargs->n_indexable, qargs->n_processed,
		       qargs->n_indexable - qargs->n_indexable_last_stats,
Thomas White's avatar
Thomas White committed
516
		       qargs->n_processed - qargs->n_processed_last_stats);
517
518
519

		qargs->n_processed_last_stats = qargs->n_processed;
		qargs->n_indexable_last_stats = qargs->n_indexable;
520
		qargs->t_last_stats = monotonic_seconds;
521
522

	}
523

524
525
	free(pargs->filename);
	free(pargs);
526
527
528
}


529
530
531
static int parse_cell_reduction(const char *scellr, int *err,
                                int *reduction_needs_cell)
{
Thomas White's avatar
Thomas White committed
532
	*err = 0;
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
	if ( strcmp(scellr, "none") == 0 ) {
		*reduction_needs_cell = 0;
		return CELLR_NONE;
	} else if ( strcmp(scellr, "reduce") == 0) {
		*reduction_needs_cell = 1;
		return CELLR_REDUCE;
	} else if ( strcmp(scellr, "compare") == 0) {
		*reduction_needs_cell = 1;
		return CELLR_COMPARE;
	} else if ( strcmp(scellr, "compare_ab") == 0) {
		*reduction_needs_cell = 1;
		return CELLR_COMPARE_AB;
	} else {
		*err = 1;
		*reduction_needs_cell = 0;
		return CELLR_NONE;
	}
}


Thomas White's avatar
Thomas White committed
553
554
555
556
int main(int argc, char *argv[])
{
	int c;
	char *filename = NULL;
557
	char *outfile = NULL;
Thomas White's avatar
Thomas White committed
558
	FILE *fh;
559
	FILE *ofh;
560
	char *rval = NULL;
Thomas White's avatar
Thomas White committed
561
	int n_images;
562
	int config_noindex = 0;
563
564
	int config_cmfilter = 0;
	int config_noisefilter = 0;
565
	int config_verbose = 0;
566
	int config_satcorr = 1;
567
	int config_checkprefix = 1;
568
	int config_closer = 1;
569
	int config_insane = 0;
570
	int config_bgsub = 1;
571
	int config_basename = 0;
572
	float threshold = 800.0;
573
	float min_gradient = 100000.0;
Thomas White's avatar
Thomas White committed
574
	float min_snr = 5.0;
575
	double min_int_snr = -INFINITY;
Thomas White's avatar
Thomas White committed
576
577
	struct detector *det;
	char *geometry = NULL;
Thomas White's avatar
Thomas White committed
578
579
580
581
	IndexingMethod *indm;
	IndexingPrivate **ipriv;
	int indexer_needs_cell;
	int reduction_needs_cell;
Thomas White's avatar
Thomas White committed
582
	char *indm_str = NULL;
583
	UnitCell *cell;
Thomas White's avatar
Thomas White committed
584
	char *pdb = NULL;
585
	char *prefix = NULL;
586
	char *speaks = NULL;
587
	char *scellr = NULL;
588
	char *toler = NULL;
Thomas White's avatar
Thomas White committed
589
	float tols[4] = {5.0, 5.0, 5.0, 1.5}; /* a,b,c,angles (%,%,%,deg) */
590
	int cellr;
591
	int peaks;
592
	int nthreads = 1;
593
	pthread_mutex_t output_mutex = PTHREAD_MUTEX_INITIALIZER;
594
	char *prepare_line;
595
	char prepare_filename[1024];
596
	struct queue_args qargs;
597
	struct beam_params *beam = NULL;
Thomas White's avatar
Thomas White committed
598
	char *element = NULL;
599
	double nominal_photon_energy;
Thomas White's avatar
Thomas White committed
600
	int stream_flags = STREAM_INTEGRATED;
601
602
603
604
	int cpu_num = 0;
	int cpu_groupsize = 1;
	int cpu_offset = 0;
	char *endptr;
605
	char *hdf5_peak_path = NULL;
606
	struct copy_hdf5_field *copyme;
607
608
609
610
	char *intrad = NULL;
	float ir_inn = 4.0;
	float ir_mid = 5.0;
	float ir_out = 7.0;
611
612
613
614
615
616

	copyme = new_copy_hdf5_field_list();
	if ( copyme == NULL ) {
		ERROR("Couldn't allocate HDF5 field list.\n");
		return 1;
	}
Thomas White's avatar
Thomas White committed
617
618
619
620
621

	/* Long options */
	const struct option longopts[] = {
		{"help",               0, NULL,               'h'},
		{"input",              1, NULL,               'i'},
622
		{"output",             1, NULL,               'o'},
623
		{"no-index",           0, &config_noindex,     1},
Thomas White's avatar
Thomas White committed
624
		{"indexing",           1, NULL,               'z'},
Thomas White's avatar
Thomas White committed
625
		{"geometry",           1, NULL,               'g'},
626
		{"beam",               1, NULL,               'b'},
627
628
		{"filter-cm",          0, &config_cmfilter,    1},
		{"filter-noise",       0, &config_noisefilter, 1},
629
		{"verbose",            0, &config_verbose,     1},
Thomas White's avatar
Thomas White committed
630
		{"pdb",                1, NULL,               'p'},
631
		{"prefix",             1, NULL,               'x'},
632
633
		{"no-sat-corr",        0, &config_satcorr,     0},
		{"sat-corr",           0, &config_satcorr,     1}, /* Compat */
634
		{"threshold",          1, NULL,               't'},
635
		{"no-check-prefix",    0, &config_checkprefix, 0},
636
		{"no-closer-peak",     0, &config_closer,      0},
637
		{"insane",             0, &config_insane,      1},
Thomas White's avatar
Thomas White committed
638
		{"image",              1, NULL,               'e'},
639
		{"basename",           0, &config_basename,    1},
Thomas White's avatar
Thomas White committed
640
641
642
643
644
645
		{"bg-sub",             0, &config_bgsub,       1}, /* Compat */
		{"no-bg-sub",          0, &config_bgsub,       0},

		{"peaks",              1, NULL,                2},
		{"cell-reduction",     1, NULL,                3},
		{"min-gradient",       1, NULL,                4},
Thomas White's avatar
Thomas White committed
646
		{"record",             1, NULL,                5},
647
648
		{"cpus",               1, NULL,                6},
		{"cpugroup",           1, NULL,                7},
649
		{"cpuoffset",          1, NULL,                8},
650
		{"hdf5-peaks",         1, NULL,                9},
651
		{"copy-hdf5-field",    1, NULL,               10},
Thomas White's avatar
Thomas White committed
652
653
654
		{"min-snr",            1, NULL,               11},
		{"min-integration-snr",1, NULL,               12},
		{"tolerance",          1, NULL,               13},
655
		{"int-radius",         1, NULL,               14},
Thomas White's avatar
Thomas White committed
656
657
658
659
		{0, 0, NULL, 0}
	};

	/* Short options */
Thomas White's avatar
Thomas White committed
660
	while ((c = getopt_long(argc, argv, "hi:wp:j:x:g:t:o:b:e:",
Thomas White's avatar
Thomas White committed
661
662
	                        longopts, NULL)) != -1)
	{
Thomas White's avatar
Thomas White committed
663
		switch (c) {
Thomas White's avatar
Thomas White committed
664
665

			case 'h' :
Thomas White's avatar
Thomas White committed
666
667
668
			show_help(argv[0]);
			return 0;

Thomas White's avatar
Thomas White committed
669
			case 'i' :
Thomas White's avatar
Thomas White committed
670
671
672
			filename = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
673
			case 'o' :
674
675
676
			outfile = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
677
			case 'z' :
Thomas White's avatar
Thomas White committed
678
679
680
			indm_str = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
681
			case 'p' :
Thomas White's avatar
Thomas White committed
682
683
684
			pdb = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
685
			case 'x' :
686
687
688
			prefix = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
689
			case 'j' :
690
691
692
			nthreads = atoi(optarg);
			break;

Thomas White's avatar
Thomas White committed
693
			case 'g' :
Thomas White's avatar
Thomas White committed
694
695
696
			geometry = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
697
			case 't' :
698
699
700
			threshold = strtof(optarg, NULL);
			break;

Thomas White's avatar
Thomas White committed
701
			case 'b' :
702
703
704
705
706
707
708
709
			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
710
711
			case 'e' :
			element = strdup(optarg);
712
713
			break;

Thomas White's avatar
Thomas White committed
714
715
			case 2 :
			speaks = strdup(optarg);
716
717
			break;

Thomas White's avatar
Thomas White committed
718
719
			case 3 :
			scellr = strdup(optarg);
720
721
			break;

Thomas White's avatar
Thomas White committed
722
			case 4 :
723
724
725
			min_gradient = strtof(optarg, NULL);
			break;

Thomas White's avatar
Thomas White committed
726
			case 5 :
Thomas White's avatar
Thomas White committed
727
728
729
730
			stream_flags = parse_stream_flags(optarg);
			if ( stream_flags < 0 ) return 1;
			break;

Thomas White's avatar
Thomas White committed
731
			case 6 :
732
733
734
735
736
737
738
739
			cpu_num = strtol(optarg, &endptr, 10);
			if ( !( (optarg[0] != '\0') && (endptr[0] == '\0') ) ) {
				ERROR("Invalid number of CPUs ('%s')\n",
				      optarg);
				return 1;
			}
			break;

Thomas White's avatar
Thomas White committed
740
			case 7 :
741
742
743
744
745
746
747
748
749
750
751
752
753
			cpu_groupsize = strtol(optarg, &endptr, 10);
			if ( !( (optarg[0] != '\0') && (endptr[0] == '\0') ) ) {
				ERROR("Invalid CPU group size ('%s')\n",
				      optarg);
				return 1;
			}
			if ( cpu_groupsize < 1 ) {
				ERROR("CPU group size cannot be"
				      " less than 1.\n");
				return 1;
			}
			break;

Thomas White's avatar
Thomas White committed
754
			case 8 :
755
756
757
758
759
760
761
762
763
764
765
766
			cpu_offset = strtol(optarg, &endptr, 10);
			if ( !( (optarg[0] != '\0') && (endptr[0] == '\0') ) ) {
				ERROR("Invalid CPU offset ('%s')\n",
				      optarg);
				return 1;
			}
			if ( cpu_offset < 0 ) {
				ERROR("CPU offset must be positive.\n");
				return 1;
			}
			break;

Thomas White's avatar
Thomas White committed
767
			case 9 :
768
769
770
			hdf5_peak_path = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
771
			case 10 :
772
773
774
			add_copy_hdf5_field(copyme, optarg);
			break;

Thomas White's avatar
Thomas White committed
775
776
777
778
779
780
			case 11 :
			min_snr = strtof(optarg, NULL);
			break;

			case 12 :
			min_int_snr = strtof(optarg, NULL);
Thomas White's avatar
Thomas White committed
781
782
			break;

Thomas White's avatar
Thomas White committed
783
784
785
786
			case 13 :
			toler = strdup(optarg);
			break;

787
788
789
790
			case 14 :
			intrad = strdup(optarg);
			break;

Thomas White's avatar
Thomas White committed
791
792
793
794
			case 0 :
			break;

			default :
Thomas White's avatar
Thomas White committed
795
			return 1;
Thomas White's avatar
Thomas White committed
796

Thomas White's avatar
Thomas White committed
797
798
799
800
		}

	}

801
802
803
804
805
806
	if ( (cpu_num > 0) && (cpu_num % cpu_groupsize != 0) ) {
		ERROR("Number of CPUs must be divisible by"
		      " the CPU group size.\n");
		return 1;
	}

Thomas White's avatar
Thomas White committed
807
808
809
810
811
812
813
814
815
	if ( filename == NULL ) {
		filename = strdup("-");
	}
	if ( strcmp(filename, "-") == 0 ) {
		fh = stdin;
	} else {
		fh = fopen(filename, "r");
	}
	if ( fh == NULL ) {
Thomas White's avatar
Thomas White committed
816
		ERROR("Failed to open input file '%s'\n", filename);
Thomas White's avatar
Thomas White committed
817
818
		return 1;
	}
Thomas White's avatar
Thomas White committed
819
	free(filename);
Thomas White's avatar
Thomas White committed
820

821
822
823
824
825
826
827
828
829
830
831
832
833
834
	if ( outfile == NULL ) {
		outfile = strdup("-");
	}
	if ( strcmp(outfile, "-") == 0 ) {
		ofh = stdout;
	} else {
		ofh = fopen(outfile, "w");
	}
	if ( ofh == NULL ) {
		ERROR("Failed to open output file '%s'\n", outfile);
		return 1;
	}
	free(outfile);

835
836
837
838
	if ( hdf5_peak_path == NULL ) {
		hdf5_peak_path = strdup("/processing/hitfinder/peakinfo");
	}

839
840
841
842
843
844
845
846
847
848
849
850
851
	if ( speaks == NULL ) {
		speaks = strdup("zaef");
		STATUS("You didn't specify a peak detection method.\n");
		STATUS("I'm using 'zaef' for you.\n");
	}
	if ( strcmp(speaks, "zaef") == 0 ) {
		peaks = PEAK_ZAEF;
	} else if ( strcmp(speaks, "hdf5") == 0 ) {
		peaks = PEAK_HDF5;
	} else {
		ERROR("Unrecognised peak detection method '%s'\n", speaks);
		return 1;
	}
Thomas White's avatar
Thomas White committed
852
	free(speaks);
853

Thomas White's avatar
Thomas White committed
854
855
856
857
	if ( pdb == NULL ) {
		pdb = strdup("molecule.pdb");
	}

858
	if ( prefix == NULL ) {
Thomas White's avatar
Thomas White committed
859
		prefix = strdup("");
860
	} else {
861
862
863
		if ( config_checkprefix ) {
			prefix = check_prefix(prefix);
		}
864
865
	}

866
	if ( nthreads == 0 ) {
867
868
869
870
		ERROR("Invalid number of threads.\n");
		return 1;
	}

871
872
	if ( (indm_str == NULL) ||
	     ((indm_str != NULL) && (strcmp(indm_str, "none") == 0)) ) {
873
		STATUS("Not indexing anything.\n");
874
		indexer_needs_cell = 0;
875
876
877
		reduction_needs_cell = 0;
		indm = NULL;
		cellr = CELLR_NONE;
Thomas White's avatar
Thomas White committed
878
	} else {
879
880
881
882
883
884
885
886
		if ( indm_str == NULL ) {
			STATUS("You didn't specify an indexing method, so I "
			       " won't try to index anything.\n"
			       "If that isn't what you wanted, re-run with"
			       " --indexing=<method>.\n");
			indm = NULL;
			indexer_needs_cell = 0;
		} else {
Thomas White's avatar
Thomas White committed
887
888
			indm = build_indexer_list(indm_str,
			                          &indexer_needs_cell);
889
890
891
892
893
			if ( indm == NULL ) {
				ERROR("Invalid indexer list '%s'\n", indm_str);
				return 1;
			}
			free(indm_str);
Thomas White's avatar
Thomas White committed
894
		}
Thomas White's avatar
Thomas White committed
895

896
897
898
899
900
901
902
		reduction_needs_cell = 0;
		if ( scellr == NULL ) {
			STATUS("You didn't specify a cell reduction method, so"
			       " I'm going to use 'reduce'.\n");
			cellr = CELLR_REDUCE;
			reduction_needs_cell = 1;
		} else {
903
904
905
906
907
908
909
910
911
			int err;
			cellr = parse_cell_reduction(scellr, &err,
			                             &reduction_needs_cell);
			if ( err ) {
				ERROR("Unrecognised cell reduction '%s'\n",
			              scellr);
				return 1;
			}
			free(scellr);
912
		}
913
914
	}

915
916
917
	/* No indexing -> no reduction */
	if ( indm == NULL ) reduction_needs_cell = 0;

918
919
	if ( toler != NULL ) {
		int ttt;
Thomas White's avatar
Thomas White committed
920
921
		ttt = sscanf(toler, "%f,%f,%f,%f",
		             &tols[0], &tols[1], &tols[2], &tols[3] );
922
923
924
925
926
927
		if ( ttt != 4 ) {
			ERROR("Invalid parameters for '--tolerance'\n");
			return 1;
		}
	}

928
929
930
931
932
933
934
935
936
937
938
939
940
	if ( intrad != NULL ) {
		int r;
		r = sscanf(intrad, "%f,%f,%f", &ir_inn, &ir_mid, &ir_out);
		if ( r != 3 ) {
			ERROR("Invalid parameters for '--int-radius'\n");
			return 1;
		}
	} else {
		STATUS("WARNING: You did not specify --int-radius.\n");
		STATUS("WARNING: I will use the default values, which are"
		       " probably not appropriate for your patterns.\n");
	}

Thomas White's avatar
Thomas White committed
941
942
943
944
945
946
947
948
949
950
951
952
	if ( geometry == NULL ) {
		ERROR("You need to specify a geometry file with --geometry\n");
		return 1;
	}

	det = get_detector_geometry(geometry);
	if ( det == NULL ) {
		ERROR("Failed to read detector geometry from '%s'\n", geometry);
		return 1;
	}
	free(geometry);

Thomas White's avatar
Thomas White committed
953
	if ( reduction_needs_cell || indexer_needs_cell ) {
954
955
		cell = load_cell_from_pdb(pdb);
		if ( cell == NULL ) {
956
957
958
			ERROR("Couldn't read unit cell (from %s)\n", pdb);
			return 1;
		}
959
	} else {
Thomas White's avatar
Thomas White committed
960
961
		STATUS("No cell needed for these choices of indexing"
		       " and reduction.\n");
962
		cell = NULL;
963
	}
964
	free(pdb);
965

Thomas White's avatar
Thomas White committed
966
	write_stream_header(ofh, argc, argv);
967

968
969
970
971
972
973
974
975
	if ( beam != NULL ) {
		nominal_photon_energy = beam->photon_energy;
	} else {
		STATUS("No beam parameters file was given, so I'm taking the"
		       " nominal photon energy to be 2 keV.\n");
		nominal_photon_energy = 2000.0;
	}

976
	/* Get first filename and use it to set up the indexing */
977
	prepare_line = malloc(1024*sizeof(char));
978
979
980
981
	rval = fgets(prepare_line, 1023, fh);
	if ( rval == NULL ) {
		ERROR("Failed to get filename to prepare indexing.\n");
		return 1;
982
	}
983
	chomp(prepare_line);
984
985
986
987
988
989
	if ( config_basename ) {
		char *tmp;
		tmp = safe_basename(prepare_line);
		free(prepare_line);
		prepare_line = tmp;
	}
990
991
992
993
	snprintf(prepare_filename, 1023, "%s%s", prefix, prepare_line);
	qargs.use_this_one_instead = prepare_line;

	/* Prepare the indexer */
Thomas White's avatar
Thomas White committed
994
995
996
997
998
999
1000
	if ( indm != NULL ) {
		ipriv = prepare_indexing(indm, cell, prepare_filename, det,
		                         nominal_photon_energy);
		if ( ipriv == NULL ) {
			ERROR("Failed to prepare indexing.\n");
			return 1;
		}
For faster browsing, not all history is shown. View entire blame