1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
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
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
149
150
151
152
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
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
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
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
|
/*
* partialator.c
*
* Scaling and post refinement for coherent nanocrystallography
*
* Copyright © 2012-2018 Deutsches Elektronen-Synchrotron DESY,
* a research centre of the Helmholtz Association.
*
* Authors:
* 2010-2018 Thomas White <taw@physics.org>
*
* 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/>.
*
*/
#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 <assert.h>
#include <pthread.h>
#include <gsl/gsl_errno.h>
#include <sys/stat.h>
#include <image.h>
#include <utils.h>
#include <symmetry.h>
#include <stream.h>
#include <geometry.h>
#include <peaks.h>
#include <thread-pool.h>
#include <reflist.h>
#include <reflist-utils.h>
#include <cell.h>
#include <cell-utils.h>
#include "scaling.h"
#include "post-refinement.h"
#include "merge.h"
#include "rejection.h"
struct csplit_hash_entry
{
int n_events;
char **events;
int *datasets;
};
#define CSPLIT_HASH_MAX (65521)
struct custom_split
{
int n_events_total;
int n_datasets;
char **dataset_names;
struct csplit_hash_entry hashes[CSPLIT_HASH_MAX];
};
static int csplit_hash(const char *id)
{
int i;
size_t len = strlen(id);
int h = 0;
for ( i=0; i<len; i++ ) {
h = (h*31 + id[i]) % CSPLIT_HASH_MAX;
}
assert(h < CSPLIT_HASH_MAX);
return h;
}
static void add_to_hash_entry(struct csplit_hash_entry *he, const char *id,
int dsn)
{
he->events = realloc(he->events, (1+he->n_events)*sizeof(char *));
he->datasets = realloc(he->datasets, (1+he->n_events)*sizeof(int));
if ( (he->events == NULL) || (he->datasets == NULL) ) {
ERROR("Failed to grow csplit hash entry.\n");
abort();
}
he->events[he->n_events] = strdup(id);
he->datasets[he->n_events] = dsn;
he->n_events++;
}
static signed int find_dsn_for_id(struct custom_split *csplit, const char *id)
{
int hash = csplit_hash(id);
int i;
struct csplit_hash_entry *he = &csplit->hashes[hash];
for ( i=0; i<he->n_events; i++ ) {
if ( strcmp(he->events[i], id) == 0 ) {
return he->datasets[i];
}
}
return -1;
}
/* Find dataset number */
static int find_dsn(struct custom_split *csplit, const char *ds)
{
int i;
for ( i=0; i<csplit->n_datasets; i++ ) {
if ( strcmp(csplit->dataset_names[i], ds) == 0 ) {
return i;
}
}
csplit->dataset_names = realloc(csplit->dataset_names,
(1+csplit->n_datasets)*sizeof(char *));
if ( csplit->dataset_names == NULL ) {
ERROR("Failed to grow list of dataset names\n");
abort();
}
csplit->n_datasets++;
csplit->dataset_names[csplit->n_datasets-1] = strdup(ds);
return csplit->n_datasets-1;
}
/* Add arbitrary ID 'id' to dataset table with name 'ds' */
static void add_to_csplit(struct custom_split *csplit, const char *id,
const char *ds)
{
int dsn;
int hash;
struct csplit_hash_entry *he;
dsn = find_dsn(csplit, ds);
hash = csplit_hash(id);
he = &csplit->hashes[hash];
add_to_hash_entry(he, id, dsn);
csplit->n_events_total++;
}
/* Write two-way split results (i.e. for CC1/2 etc) for this list of crystals */
static void write_split(Crystal **crystals, int n_crystals, const char *outfile,
int nthreads, PartialityModel pmodel,
int min_measurements, SymOpList *sym, double push_res)
{
char tmp[1024];
RefList *split;
Crystal *crystals1[n_crystals];
Crystal *crystals2[n_crystals];
int n_crystals1 = 0;
int n_crystals2 = 0;
int i;
for ( i=0; i<n_crystals; i++ ) {
if ( i % 2 ) {
crystals1[n_crystals1] = crystals[i];
n_crystals1++;
} else {
crystals2[n_crystals2] = crystals[i];
n_crystals2++;
}
}
snprintf(tmp, 1024, "%s1", outfile);
split = merge_intensities(crystals1, n_crystals1, nthreads,
min_measurements, push_res, 1);
if ( split == NULL ) {
ERROR("Not enough crystals for two way split!\n");
return;
}
STATUS("Writing two-way split to %s ", tmp);
write_reflist_2(tmp, split, sym);
reflist_free(split);
snprintf(tmp, 1024, "%s2", outfile);
split = merge_intensities(crystals2, n_crystals2, nthreads,
min_measurements, push_res, 1);
STATUS("and %s\n", tmp);
write_reflist_2(tmp, split, sym);
reflist_free(split);
}
static char *insert_into_filename(const char *fn, const char *add)
{
int i;
char *out;
out = malloc(strlen(fn) + strlen(add) + 2);
if ( out == NULL ) return NULL;
for ( i=strlen(fn); i>0; i-- ) {
if ( fn[i] == '.' ) {
strncpy(out, fn, i);
out[i] = '\0';
strcat(out, "-");
strcat(out, add);
strcat(out, fn+i);
return out;
}
}
/* Fallback if fn does not contain a dot */
strcpy(out, fn);
strcat(out, "-");
strcat(out, add);
return out;
}
/* Write custom split results (including a two-way split) */
static void write_custom_split(struct custom_split *csplit, int dsn,
Crystal **crystals, int n_crystals,
PartialityModel pmodel, int min_measurements,
double push_res, SymOpList *sym, int nthreads,
const char *outfile)
{
char *tmp;
RefList *split;
Crystal *crystalsn[n_crystals];
int n_crystalsn = 0;
int i;
for ( i=0; i<n_crystals; i++ ) {
const char *fn;
struct event *ev;
char *evs;
char *id;
int dsn_crystal;
fn = crystal_get_image(crystals[i])->filename;
ev = crystal_get_image(crystals[i])->event;
evs = get_event_string(ev);
id = malloc(strlen(evs)+strlen(fn)+2);
if ( id == NULL ) {
ERROR("Failed to allocate ID\n");
return;
}
strcpy(id, fn);
strcat(id, " ");
strcat(id, evs);
dsn_crystal = find_dsn_for_id(csplit, id);
free(id);
if ( dsn == dsn_crystal ) {
crystalsn[n_crystalsn] = crystals[i];
n_crystalsn++;
}
}
tmp = insert_into_filename(outfile, csplit->dataset_names[dsn]);
if ( n_crystalsn == 0 ) {
ERROR("Not writing dataset '%s' because it contains no "
"crystals\n", csplit->dataset_names[dsn]);
return;
}
STATUS("Writing dataset '%s' to %s (%i crystals)\n",
csplit->dataset_names[dsn], tmp, n_crystalsn);
split = merge_intensities(crystalsn, n_crystalsn, nthreads,
min_measurements, push_res, 1);
write_reflist_2(tmp, split, sym);
reflist_free(split);
write_split(crystalsn, n_crystalsn, tmp, nthreads, pmodel,
min_measurements, sym, push_res);
free(tmp);
}
static void show_help(const char *s)
{
printf("Syntax: %s [options]\n\n", s);
printf(
"Scaling and post refinement for coherent nanocrystallography.\n"
"\n"
" -h, --help Display this help message.\n"
" --version Print CrystFEL version number and exit.\n"
"\n"
" -i, --input=<filename> Specify the name of the input 'stream'.\n"
" -o, --output=<filename> Output filename. Default: partialator.hkl.\n"
" --output-every-cycle Write .hkl* and .params files in every cycle.\n"
" -y, --symmetry=<sym> Merge according to symmetry <sym>.\n"
" --start-after=<n> Skip <n> crystals at the start of the stream.\n"
" --stop-after=<n> Stop after merging <n> crystals.\n"
" -n, --iterations=<n> Run <n> cycles of scaling and post-refinement.\n"
" --no-scale Disable scale factor (G, B) refinement.\n"
" --no-Bscale Disable B factor scaling.\n"
" --no-pr Disable orientation/physics refinement.\n"
" --no-deltacchalf Disable rejection based on deltaCChalf.\n"
" -m, --model=<model> Specify partiality model.\n"
" --min-measurements=<n> Minimum number of measurements to require.\n"
" --no-polarisation Disable polarisation correction.\n"
" --max-adu=<n> Saturation value of detector.\n"
" --min-res=<n> Merge only crystals which diffract above <n> A.\n"
" --push-res=<n> Merge higher than apparent resolution cutoff.\n"
" -j <n> Run <n> analyses in parallel.\n"
" --no-free Disable cross-validation (testing only).\n"
" --custom-split List of files for custom dataset splitting.\n"
" --max-rel-B Maximum allowable relative |B| factor.\n"
" --no-logs Do not write extensive log files.\n"
" -w <pg> Apparent point group for resolving ambiguities.\n"
" --operator=<op> Indexing ambiguity operator for resolving.\n"
" --force-bandwidth=<n> Set all bandwidths to <n> (fraction).\n"
" --force-radius=<n> Set all profile radii to <n> nm^-1.\n");
}
static signed int find_first_crystal(Crystal **crystals, int n_crystals,
struct custom_split *csplit, int dsn)
{
int i;
for ( i=0; i<n_crystals; i++ ) {
const char *fn;
struct event *ev;
char *evs;
char *id;
int dsn_crystal;
fn = crystal_get_image(crystals[i])->filename;
ev = crystal_get_image(crystals[i])->event;
evs = get_event_string(ev);
id = malloc(strlen(evs)+strlen(fn)+2);
if ( id == NULL ) {
ERROR("Failed to allocate ID\n");
return -1;
}
strcpy(id, fn);
strcat(id, " ");
strcat(id, evs);
dsn_crystal = find_dsn_for_id(csplit, id);
free(id);
if ( dsn == dsn_crystal ) return i;
}
return -1;
}
static void check_csplit(Crystal **crystals, int n_crystals,
struct custom_split *csplit)
{
int i;
int n_nosplit = 0;
int n_split = 0;
int n_cry = 0;
int n_nocry = 0;
STATUS("Checking your custom split datasets...\n");
for ( i=0; i<n_crystals; i++ ) {
const char *fn;
struct event *ev;
char *evs;
char *id;
int dsn_crystal;
fn = crystal_get_image(crystals[i])->filename;
ev = crystal_get_image(crystals[i])->event;
evs = get_event_string(ev);
id = malloc(strlen(evs)+strlen(fn)+2);
if ( id == NULL ) {
ERROR("Failed to allocate ID\n");
return;
}
strcpy(id, fn);
strcat(id, " ");
strcat(id, evs);
dsn_crystal = find_dsn_for_id(csplit, id);
free(id);
if ( dsn_crystal == -1 ) {
n_nosplit++;
} else {
n_split++;
}
}
for ( i=0; i<csplit->n_datasets; i++ ) {
/* Try to find a crystal with dsn = i */
if ( find_first_crystal(crystals, n_crystals, csplit, i) != -1 )
{
n_cry++;
} else {
n_nocry++;
STATUS("Dataset %s has no crystals.\n",
csplit->dataset_names[i]);
}
}
STATUS("Please check that these numbers match your expectations:\n");
STATUS(" Number of crystals assigned to a dataset: %i\n", n_split);
STATUS("Number of crystals with no dataset asssigned: %i\n", n_nosplit);
STATUS("Number of datasets with at least one crystal: %i\n", n_cry);
STATUS(" Number of datasets with no crystals: %i\n", n_nocry);
}
static struct custom_split *load_custom_split(const char *filename)
{
struct custom_split *csplit;
FILE *fh;
int i;
csplit = malloc(sizeof(struct custom_split));
if ( csplit == NULL ) return NULL;
csplit->n_datasets = 0;
csplit->n_events_total = 0;
csplit->dataset_names = NULL;
for ( i=0; i<CSPLIT_HASH_MAX; i++ ) {
csplit->hashes[i].n_events = 0;
csplit->hashes[i].events = NULL;
csplit->hashes[i].datasets = NULL;
}
fh = fopen(filename, "r");
if ( fh == NULL ) {
ERROR("Failed to open '%s'\n", filename);
free(csplit);
return NULL;
}
do {
char *rval;
char line[1024];
char *fn;
char *evs;
char *ds;
char *id;
int n;
char **bits;
rval = fgets(line, 1023, fh);
if ( rval == NULL ) break;
chomp(line);
notrail(line);
n = assplode(line, " \t,", &bits, ASSPLODE_NONE);
if ( n < 2 ) {
ERROR("Badly formatted line '%s'\n", line);
return NULL;
}
if ( n == 3 ) {
/* Filename, event, dataset */
fn = bits[0];
evs = bits[1];
ds = bits[2];
} else {
fn = bits[0];
evs = get_event_string(NULL);
ds = bits[1];
}
free(bits);
id = malloc(strlen(fn) + strlen(evs) + 2);
strcpy(id, fn);
strcat(id, " ");
strcat(id, evs);
add_to_csplit(csplit, id, ds);
free(id);
free(fn);
free(evs);
free(ds);
} while ( 1 );
fclose(fh);
int max = 0;
for ( i=0; i<CSPLIT_HASH_MAX; i++ ) {
if ( csplit->hashes[i].n_events > max ) {
max = csplit->hashes[i].n_events;
}
}
STATUS("Hash table load factor = %.2f (max %i)\n",
(double)csplit->n_events_total / CSPLIT_HASH_MAX, max);
return csplit;
}
static void display_progress(int n_images, int n_crystals)
{
if ( !isatty(STDERR_FILENO) ) return;
if ( tcgetpgrp(STDERR_FILENO) != getpgrp() ) return;
pthread_mutex_lock(&stderr_lock);
fprintf(stderr, "\r%i images loaded, %i crystals.",
n_images, n_crystals);
pthread_mutex_unlock(&stderr_lock);
fflush(stdout);
}
static RefList *apply_max_adu(RefList *list, double max_adu)
{
RefList *nlist;
Reflection *refl;
RefListIterator *iter;
nlist = reflist_new();
if ( nlist == NULL ) return NULL;
for ( refl = first_refl(list, &iter);
refl != NULL;
refl = next_refl(refl, iter) )
{
if ( get_peak(refl) < max_adu ) {
signed int h, k, l;
get_indices(refl, &h, &k, &l);
Reflection *nrefl = add_refl(nlist, h, k, l);
copy_data(nrefl, refl);
}
}
reflist_free(list);
return nlist;
}
static void skip_to_end(FILE *fh)
{
int c;
do {
c = fgetc(fh);
} while ( (c != '\n') && (c != EOF) );
}
static int set_initial_params(Crystal *cr, FILE *fh)
{
if ( fh != NULL ) {
int err;
int n;
float osf, B;
err = fscanf(fh, "%i %f %f", &n, &osf, &B);
if ( err != 3 ) {
ERROR("Failed to read parameters.\n");
return 1;
}
crystal_set_osf(cr, osf);
crystal_set_Bfac(cr, B*1e-20);
skip_to_end(fh);
} else {
crystal_set_osf(cr, 1.0);
crystal_set_Bfac(cr, 0.0);
}
return 0;
}
/* Flag a random 5% of reflections */
static void select_free_reflections(RefList *list, gsl_rng *rng)
{
Reflection *refl;
RefListIterator *iter;
for ( refl = first_refl(list, &iter);
refl != NULL;
refl = next_refl(refl, iter) )
{
set_flag(refl, random_flat(rng, 1.0) > 0.95);
}
}
static void write_to_pgraph(FILE *fh, RefList *list, RefList *full, Crystal *cr,
int fr, signed int inum)
{
Reflection *refl;
RefListIterator *iter;
double G = crystal_get_osf(cr);
double B = crystal_get_Bfac(cr);
UnitCell *cell = crystal_get_cell(cr);
char ins[5];
if ( inum >= 0 ) {
snprintf(ins, 4, "%i", inum);
} else {
ins[0] = 'F';
ins[1] = '\0';
}
for ( refl = first_refl(list, &iter);
refl != NULL;
refl = next_refl(refl, iter) )
{
signed int h, k, l;
double pobs, pcalc;
double res, corr, Ipart;
Reflection *match;
if ( !get_flag(refl) ) continue; /* Not free-flagged */
/* Strong reflections only */
if ( get_intensity(refl) < 3.0*get_esd_intensity(refl) ) continue;
get_indices(refl, &h, &k, &l);
res = resolution(cell, h, k, l);
if ( 2.0*res > crystal_get_resolution_limit(cr) ) continue;
match = find_refl(full, h, k, l);
if ( match == NULL ) continue;
/* Don't calculate pobs if reference reflection is weak */
if ( fabs(get_intensity(match)) / get_esd_intensity(match) < 3.0 ) continue;
/* Calculated partiality */
pcalc = get_partiality(refl);
/* Observed partiality */
corr = G * exp(B*res*res) * get_lorentz(refl);
Ipart = get_intensity(refl) * corr;
pobs = Ipart / get_intensity(match);
fprintf(fh, "%5i %4i %4i %4i %e %e %8.3f %8.3f %s\n",
fr, h, k, l, 2*res, Ipart, pcalc, pobs, ins);
}
}
static void write_pgraph(RefList *full, Crystal **crystals, int n_crystals,
signed int iter, const char *suff)
{
FILE *fh;
char tmp[256];
int i;
snprintf(tmp, 256, "pr-logs/pgraph%s.dat", suff);
if ( iter == 0 ) {
fh = fopen(tmp, "w");
} else {
fh = fopen(tmp, "a");
}
if ( fh == NULL ) {
ERROR("Failed to open '%s'\n", tmp);
return;
}
if ( iter == 0 ) {
fprintf(fh, " Crystal h k l 1/d(m) Ipart pcalc pobs iteration\n");
}
for ( i=0; i<n_crystals; i++ ) {
if ( crystal_get_user_flag(crystals[i]) != 0 ) continue;
write_to_pgraph(fh, crystal_get_reflections(crystals[i]), full,
crystals[i], i, iter);
}
fclose(fh);
}
static void all_residuals(Crystal **crystals, int n_crystals, RefList *full,
double *presidual, double *pfree_residual,
double *plog_residual, double *pfree_log_residual,
int *pn_used)
{
int i;
int n_used = 0;
int n_nan_linear = 0;
int n_nan_linear_free = 0;
int n_nan_log = 0;
int n_nan_log_free = 0;
*presidual = 0.0;
*pfree_residual = 0.0;
*plog_residual = 0.0;
*pfree_log_residual = 0.0;
for ( i=0; i<n_crystals; i++ ) {
double r, free_r, log_r, free_log_r;
if ( crystal_get_user_flag(crystals[i]) ) continue;
/* Scaling should have been done right before calling this */
r = residual(crystals[i], full, 0, NULL, NULL);
free_r = residual(crystals[i], full, 1, NULL, NULL);
log_r = log_residual(crystals[i], full, 0, NULL, NULL);
free_log_r = log_residual(crystals[i], full, 1, NULL, NULL);
if ( isnan(r) ) n_nan_linear++;
if ( isnan(free_r) ) n_nan_linear_free++;
if ( isnan(log_r) ) n_nan_log++;
if ( isnan(free_log_r) ) n_nan_log_free++;
if ( isnan(r) || isnan(free_r)
|| isnan(log_r) || isnan(free_log_r) ) continue;
*presidual += r;
*pfree_residual += free_r;
*plog_residual += log_r;
*pfree_log_residual += free_log_r;
n_used++;
}
if ( n_nan_linear ) {
ERROR("WARNING: %i crystals had NaN linear residuals\n",
n_nan_linear);
}
if ( n_nan_linear_free ) {
ERROR("WARNING: %i crystals had NaN linear free residuals\n",
n_nan_linear_free);
}
if ( n_nan_log ) {
ERROR("WARNING: %i crystals had NaN log residuals\n",
n_nan_log);
}
if ( n_nan_log_free ) {
ERROR("WARNING: %i crystals had NaN log free residuals\n",
n_nan_log_free);
}
*pn_used = n_used;
}
static void show_all_residuals(Crystal **crystals, int n_crystals,
RefList *full)
{
double dev, free_dev, log_dev, free_log_dev;
int n;
all_residuals(crystals, n_crystals, full,
&dev, &free_dev, &log_dev, &free_log_dev, &n);
STATUS("Residuals:"
" linear linear free log log free\n");
STATUS(" ");
STATUS("%15e %15e %15e %15e (%i crystals)\n",
dev, free_dev, log_dev, free_log_dev, n);
}
struct log_qargs
{
int iter;
int next;
Crystal **crystals;
int n_crystals;
RefList *full;
int scaleflags;
};
struct log_args
{
Crystal *cr;
RefList *full;
int scaleflags;
int iter;
int cnum;
};
static void *get_log_task(void *vp)
{
struct log_qargs *qargs = vp;
struct log_args *task;
if ( qargs->next >= qargs->n_crystals ) return NULL;
task = malloc(sizeof(struct log_args));
if ( task == NULL ) return NULL;
task->cr = qargs->crystals[qargs->next];
task->full = qargs->full;
task->iter = qargs->iter;
task->cnum = qargs->next;
task->scaleflags = qargs->scaleflags;
qargs->next += 20;
return task;
}
static void write_logs(void *vp, int cookie)
{
struct log_args *args = vp;
write_specgraph(args->cr, args->full, args->iter, args->cnum);
write_gridscan(args->cr, args->full, args->iter, args->cnum,
args->scaleflags);
write_test_logs(args->cr, args->full, args->iter, args->cnum);
}
static void done_log(void *qargs, void *vp)
{
struct log_args *task = vp;
free(task);
}
static void write_logs_parallel(Crystal **crystals, int n_crystals,
RefList *full, int iter, int n_threads,
int scaleflags)
{
struct log_qargs qargs;
qargs.iter = iter;
qargs.next = 0;
qargs.full = full;
qargs.crystals = crystals;
qargs.n_crystals = n_crystals;
qargs.scaleflags = scaleflags;
STATUS("Writing logs...\n");
run_threads(n_threads, write_logs, get_log_task, done_log, &qargs,
n_crystals/20, 0, 0, 0);
STATUS("Done.\n");
}
int main(int argc, char *argv[])
{
int c;
char *infile = NULL;
char *outfile = NULL;
char *sym_str = NULL;
SymOpList *sym;
SymOpList *amb;
SymOpList *w_sym;
int nthreads = 1;
int i;
int n_iter = 10;
RefList *full;
int n_images = 0;
int n_crystals = 0;
int n_crystals_seen = 0;
char cmdline[1024];
int no_scale = 0;
int no_Bscale = 0;
int no_pr = 0;
Stream *st;
Crystal **crystals;
char *pmodel_str = NULL;
PartialityModel pmodel = PMODEL_XSPHERE;
int min_measurements = 2;
char *rval;
int polarisation = 1;
int start_after = 0;
int stop_after = 0;
double max_adu = +INFINITY;
char *sparams_fn = NULL;
FILE *sparams_fh;
double push_res = +INFINITY;
gsl_rng *rng;
int no_free = 0;
int output_everycycle = 0;
char *csplit_fn = NULL;
struct custom_split *csplit = NULL;
double max_B = 1e-18;
char *rfile = NULL;
RefList *reference = NULL;
int no_logs = 0;
char *w_sym_str = NULL;
char *operator = NULL;
double force_bandwidth = -1.0;
double force_radius = -1.0;
char *audit_info;
int scaleflags = 0;
double min_res = 0.0;
int do_write_logs = 0;
int no_deltacchalf = 0;
/* Long options */
const struct option longopts[] = {
{"help", 0, NULL, 'h'},
{"version", 0, NULL, 'v'},
{"input", 1, NULL, 'i'},
{"output", 1, NULL, 'o'},
{"start-after", 1, NULL, 's'},
{"stop-after", 1, NULL, 'f'},
{"symmetry", 1, NULL, 'y'},
{"iterations", 1, NULL, 'n'},
{"model", 1, NULL, 'm'},
{"min-measurements", 1, NULL, 2},
{"max-adu", 1, NULL, 3},
{"start-params", 1, NULL, 4},
{"push-res", 1, NULL, 5},
{"res-push", 1, NULL, 5}, /* compat */
{"custom-split", 1, NULL, 6},
{"max-rel-B", 1, NULL, 7},
{"max-rel-b", 1, NULL, 7}, /* compat */
{"reference", 1, NULL, 8}, /* ssshhh! */
{"operator", 1, NULL, 9},
{"force-bandwidth", 1, NULL, 10},
{"force-radius", 1, NULL, 11},
{"min-res", 1, NULL, 12},
{"no-scale", 0, &no_scale, 1},
{"no-Bscale", 0, &no_Bscale, 1},
{"no-pr", 0, &no_pr, 1},
{"no-polarisation", 0, &polarisation, 0},
{"no-polarization", 0, &polarisation, 0}, /* compat */
{"polarisation", 0, &polarisation, 1},
{"polarization", 0, &polarisation, 1}, /* compat */
{"no-free", 0, &no_free, 1},
{"output-every-cycle", 0, &output_everycycle, 1},
{"no-logs", 0, &no_logs, 1},
{"no-deltacchalf", 0, &no_deltacchalf, 1},
{0, 0, NULL, 0}
};
cmdline[0] = '\0';
for ( i=1; i<argc; i++ ) {
strncat(cmdline, argv[i], 1023-strlen(cmdline));
strncat(cmdline, " ", 1023-strlen(cmdline));
}
/* Short options */
while ((c = getopt_long(argc, argv, "hi:o:g:b:y:n:j:m:w:",
longopts, NULL)) != -1)
{
switch (c) {
case 'h' :
show_help(argv[0]);
return 0;
case 'v' :
printf("CrystFEL: " CRYSTFEL_VERSIONSTRING "\n");
printf(CRYSTFEL_BOILERPLATE"\n");
return 0;
case 'i' :
infile = strdup(optarg);
break;
case 'j' :
nthreads = atoi(optarg);
break;
case 's' :
errno = 0;
start_after = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --start-after (%s)\n",
optarg);
return 1;
}
break;
case 'f' :
errno = 0;
stop_after = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --stop-after (%s)\n",
optarg);
return 1;
}
break;
case 'y' :
sym_str = strdup(optarg);
break;
case 'o' :
outfile = strdup(optarg);
break;
case 'n' :
n_iter = atoi(optarg);
break;
case 'm' :
pmodel_str = strdup(optarg);
break;
case 'w' :
w_sym_str = strdup(optarg);
break;
case 2 :
errno = 0;
min_measurements = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --min-measurements.\n");
return 1;
}
break;
case 3 :
errno = 0;
max_adu = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --max-adu.\n");
return 1;
}
break;
case 4 :
sparams_fn = strdup(optarg);
break;
case 5 :
errno = 0;
push_res = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --push-res.\n");
return 1;
}
push_res = push_res*1e9;
break;
case 6 :
csplit_fn = strdup(optarg);
break;
case 7 :
errno = 0;
max_B = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --max-rel-B.\n");
return 1;
}
max_B = max_B * 1e-20;
break;
case 8 :
rfile = strdup(optarg);
break;
case 9 :
operator = strdup(optarg);
break;
case 10 :
errno = 0;
force_bandwidth = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --force-bandwidth.\n");
return 1;
}
break;
case 11 :
errno = 0;
force_radius = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --force-radius.\n");
return 1;
}
force_radius *= 1e9;
break;
case 12 :
errno = 0;
min_res = strtod(optarg, &rval);
if ( *rval != '\0' ) {
ERROR("Invalid value for --min-res.\n");
return 1;
}
min_res = 1e10/min_res;
break;
case 0 :
break;
case '?' :
break;
default :
ERROR("Unhandled option '%c'\n", c);
break;
}
}
if ( nthreads < 1 ) {
ERROR("Invalid number of threads.\n");
return 1;
}
if ( infile == NULL ) {
ERROR("Please give the input filename (with -i)\n");
return 1;
}
st = open_stream_for_read(infile);
if ( st == NULL ) {
ERROR("Failed to open input stream '%s'\n", infile);
return 1;
}
if ( outfile == NULL ) {
outfile = strdup("partialator.hkl");
}
if ( sym_str == NULL ) sym_str = strdup("1");
pointgroup_warning(sym_str);
sym = get_pointgroup(sym_str);
free(sym_str);
if ( sym == NULL ) return 1;
if ( (w_sym_str != NULL) && (operator != NULL) ) {
ERROR("Specify the apparent symmetry (-w) or the operator, "
"not both.\n");
return 1;
}
if ( w_sym_str == NULL ) {
w_sym = NULL;
amb = NULL;
} else {
pointgroup_warning(w_sym_str);
w_sym = get_pointgroup(w_sym_str);
free(w_sym_str);
if ( w_sym == NULL ) return 1;
amb = get_ambiguities(w_sym, sym);
if ( amb == NULL ) {
ERROR("Couldn't find ambiguity operator.\n");
ERROR("Check that your values for -y and -w are "
"correct.\n");
return 1;
}
}
if ( operator ) {
amb = parse_symmetry_operations(operator);
if ( amb == NULL ) return 1;
set_symmetry_name(amb, "Ambiguity");
}
if ( amb != NULL ) {
STATUS("Indexing ambiguity resolution enabled. "
"The ambiguity operation(s) are:\n");
describe_symmetry(amb);
/* In contrast to ambigator, partialator can deal with multiple
* ambiguities at once */
}
if ( pmodel_str != NULL ) {
if ( strcmp(pmodel_str, "unity") == 0 ) {
pmodel = PMODEL_UNITY;
} else if ( strcmp(pmodel_str, "xsphere") == 0 ) {
pmodel = PMODEL_XSPHERE;
} else if ( strcmp(pmodel_str, "random") == 0 ) {
pmodel = PMODEL_RANDOM;
} else {
ERROR("Unknown partiality model '%s'.\n", pmodel_str);
return 1;
}
}
if ( (pmodel == PMODEL_UNITY) && !no_pr ) {
no_pr = 1;
STATUS("Setting --no-pr because we are not modelling "
"partialities (--model=unity).\n");
}
if ( no_Bscale ) {
scaleflags |= SCALE_NO_B;
}
/* Decide whether or not to create stuff in the pr-logs folder */
if ( !(no_logs || (no_pr && pmodel == PMODEL_UNITY)) ) {
do_write_logs = 1;
} else {
do_write_logs = 0;
}
if ( do_write_logs ) {
int r = mkdir("pr-logs", S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
if ( r ) {
if ( errno == EEXIST ) {
ERROR("WARNING: pr-logs folder already exists. "
"Beware of mixing old and new log files!\n");
} else {
ERROR("Failed to create pr-logs folder.\n");
return 1;
}
}
} else {
struct stat s;
if ( stat("pr-logs", &s) != -1 ) {
ERROR("WARNING: pr-logs folder exists, but I will not "
"write anything in it with these settings.\n");
}
}
/* Read the custom split list (if applicable) */
if ( csplit_fn != NULL ) {
csplit = load_custom_split(csplit_fn);
if ( csplit == NULL ) {
ERROR("Failed to load custom split list.\n");
return 1;
}
free(csplit_fn);
}
if ( rfile != NULL ) {
RefList *rread;
rread = read_reflections(rfile);
if ( rread == NULL ) {
ERROR("Failed to read reference reflections\n");
return 1;
}
reference = asymmetric_indices(rread, sym);
reflist_free(rread);
ERROR("WARNING: Using an external reference.\n");
ERROR("WARNING: If you publish a structure based on the result,"
" expect to have to retract your paper!\n");
}
gsl_set_error_handler_off();
rng = gsl_rng_alloc(gsl_rng_mt19937);
/* Fill in what we know about the images so far */
n_images = 0;
n_crystals = 0;
n_crystals_seen = 0;
crystals = NULL;
if ( sparams_fn != NULL ) {
char line[1024];
sparams_fh = fopen(sparams_fn, "r");
if ( sparams_fh == NULL ) {
ERROR("Failed to open '%s'\n", sparams_fn);
return 1;
}
if ( fgets(line, 1024, sparams_fh) == NULL ) {
ERROR("Failed to read header from %s\n", sparams_fn);
return 1;
}
STATUS("Reading initial scaling factors (G,B) from '%s'\n",
sparams_fn);
free(sparams_fn);
} else {
sparams_fh = NULL;
}
do {
RefList *as;
int i;
struct image cur;
cur.div = NAN;
cur.bw = NAN;
cur.det = NULL;
if ( read_chunk_2(st, &cur, STREAM_READ_REFLECTIONS
| STREAM_READ_UNITCELL) != 0 ) {
break;
}
if ( isnan(cur.div) || isnan(cur.bw) ) {
ERROR("Chunk doesn't contain beam parameters.\n");
return 1;
}
for ( i=0; i<cur.n_crystals; i++ ) {
Crystal *cr;
Crystal **crystals_new;
RefList *cr_refl;
struct image *image;
n_crystals_seen++;
if ( n_crystals_seen <= start_after ) continue;
if ( crystal_get_resolution_limit(cur.crystals[i]) < min_res ) continue;
crystals_new = realloc(crystals,
(n_crystals+1)*sizeof(Crystal *));
if ( crystals_new == NULL ) {
ERROR("Failed to allocate memory for crystal "
"list.\n");
return 1;
}
crystals = crystals_new;
crystals[n_crystals] = cur.crystals[i];
cr = crystals[n_crystals];
image = malloc(sizeof(struct image));
if ( image == NULL ) {
ERROR("Failed to allocatea memory for image.\n");
return 1;
}
crystal_set_image(cr, image);
*image = cur;
image->n_crystals = 1;
image->crystals = &crystals[n_crystals];
/* This is the raw list of reflections */
cr_refl = crystal_get_reflections(cr);
cr_refl = apply_max_adu(cr_refl, max_adu);
if ( polarisation ) {
polarisation_correction(cr_refl,
crystal_get_cell(cr),
image);
}
if ( !no_free ) select_free_reflections(cr_refl, rng);
as = asymmetric_indices(cr_refl, sym);
crystal_set_reflections(cr, as);
crystal_set_user_flag(cr, PRFLAG_OK);
reflist_free(cr_refl);
if ( set_initial_params(cr, sparams_fh) ) {
ERROR("Failed to set initial parameters\n");
return 1;
}
n_crystals++;
if ( n_crystals == stop_after ) break;
}
n_images++;
if ( n_images % 100 == 0 ) {
display_progress(n_images, n_crystals);
}
if ( (stop_after>0) && (n_crystals == stop_after) ) break;
} while ( 1 );
display_progress(n_images, n_crystals);
fprintf(stderr, "\n");
if ( sparams_fh != NULL ) fclose(sparams_fh);
audit_info = stream_audit_info(st);
close_stream(st);
STATUS("Initial partiality calculation...\n");
for ( i=0; i<n_crystals; i++ ) {
Crystal *cr = crystals[i];
if ( force_bandwidth > 0.0 ) {
crystal_get_image(cr)->bw = force_bandwidth;
}
if ( force_radius > 0.0 ) {
crystal_set_profile_radius(cr, force_radius);
}
update_predictions(cr);
calculate_partialities(cr, pmodel);
}
if (csplit != NULL) check_csplit(crystals, n_crystals, csplit);
/* Make a first pass at cutting out crap */
//STATUS("Early rejection...\n");
//early_rejection(crystals, n_crystals);
/* Create reference data set if we don't already have one */
if ( reference == NULL ) {
if ( !no_scale ) {
STATUS("Initial scaling...\n");
scale_all(crystals, n_crystals, nthreads, scaleflags);
}
full = merge_intensities(crystals, n_crystals, nthreads,
min_measurements, push_res, 1);
} else {
full = reference;
}
/* Check rejection and write figures of merit */
check_rejection(crystals, n_crystals, full, max_B, no_deltacchalf);
show_all_residuals(crystals, n_crystals, full);
if ( do_write_logs ) {
write_pgraph(full, crystals, n_crystals, 0, "");
write_logs_parallel(crystals, n_crystals, full, 0, nthreads,
scaleflags);
}
/* Iterate */
for ( i=0; i<n_iter; i++ ) {
STATUS("Scaling and refinement cycle %i of %i\n", i+1, n_iter);
if ( !no_pr ) {
refine_all(crystals, n_crystals, full, nthreads, pmodel,
0, i+1, no_logs, sym, amb, scaleflags);
}
/* Create new reference if needed */
if ( reference == NULL ) {
reflist_free(full);
if ( !no_scale ) {
scale_all(crystals, n_crystals, nthreads,
scaleflags);
}
full = merge_intensities(crystals, n_crystals, nthreads,
min_measurements,
push_res, 1);
} /* else full still equals reference */
check_rejection(crystals, n_crystals, full, max_B, no_deltacchalf);
show_all_residuals(crystals, n_crystals, full);
if ( do_write_logs ) {
write_pgraph(full, crystals, n_crystals, i+1, "");
}
if ( output_everycycle ) {
char tmp[1024];
snprintf(tmp, 1024, "iter%.2d_%s", i+1, outfile);
/* Output results */
STATUS("Writing overall results to %s\n", tmp);
write_reflist_2(tmp, full, sym);
/* Output split results */
write_split(crystals, n_crystals, tmp, nthreads, pmodel,
min_measurements, sym, push_res);
/* Output custom split results */
if ( csplit != NULL ) {
int j;
for ( j=0; j<csplit->n_datasets; j++ ) {
write_custom_split(csplit, j, crystals,
n_crystals, pmodel,
min_measurements,
push_res, sym,
nthreads, tmp);
}
}
}
}
/* Final merge */
STATUS("Final merge...\n");
if ( reference == NULL ) {
reflist_free(full);
if ( !no_scale ) {
scale_all(crystals, n_crystals, nthreads, scaleflags);
}
full = merge_intensities(crystals, n_crystals, nthreads,
min_measurements,
push_res, 1);
} else {
full = merge_intensities(crystals, n_crystals, nthreads,
min_measurements, push_res, 1);
}
/* Write final figures of merit (no rejection any more) */
show_all_residuals(crystals, n_crystals, full);
if ( do_write_logs ) {
write_pgraph(full, crystals, n_crystals, -1, "");
write_logs_parallel(crystals, n_crystals, full, -1, nthreads,
scaleflags);
}
/* Output results */
STATUS("Writing overall results to %s\n", outfile);
reflist_add_command_and_version(full, argc, argv);
reflist_add_notes(full, "Audit information from stream:");
reflist_add_notes(full, audit_info);
write_reflist_2(outfile, full, sym);
/* Output split results */
write_split(crystals, n_crystals, outfile, nthreads, pmodel,
min_measurements, sym, push_res);
/* Output custom split results */
if ( csplit != NULL ) {
for ( i=0; i<csplit->n_datasets; i++ ) {
write_custom_split(csplit, i, crystals, n_crystals,
pmodel, min_measurements, push_res,
sym, nthreads, outfile);
}
}
/* Clean up */
gsl_rng_free(rng);
for ( i=0; i<n_crystals; i++ ) {
reflist_free(crystal_get_reflections(crystals[i]));
crystal_free(crystals[i]);
}
reflist_free(full);
free_symoplist(sym);
free(outfile);
free(crystals);
free(infile);
return 0;
}
|