aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2021-11-25 15:50:36 +0100
committerThomas White <taw@physics.org>2021-11-25 15:50:36 +0100
commitf5d198b468d3e2c1bdece65ff5106c1989aee3c0 (patch)
tree51170cde751b812fd4e2403ff8d74a016b022be8 /doc
parent652872f38e4f1738366b16c350f27efd8cf7c99d (diff)
partialator: Handle spaces in custom split file
The csplit format is ambiguous when the filenames contain spaces. To make things a bit clearer, the file now requires the fields to be separated by exactly one space rather than any number of tabs/spaces. Fixes: https://gitlab.desy.de/thomas.white/crystfel/-/issues/55
Diffstat (limited to 'doc')
-rw-r--r--doc/man/partialator.12
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/man/partialator.1 b/doc/man/partialator.1
index 817fd7ed..6fa67593 100644
--- a/doc/man/partialator.1
+++ b/doc/man/partialator.1
@@ -251,7 +251,7 @@ partialator -i \fImy.stream \fR-o \fImy.hkl\fR -y \fImypointgroup \fB--model=xsp
.SH CUSTOM DATASET SPLITTING
When performing a time-resolved experiment (for example), it is preferable to ensure that the data for all time points has been processed identically. Rather than processing each time point independently with separate runs of partialator, it is better to process them all together and do the splitting into time points just before the final output. Consider, for example, the case of simple scaling (without a B factor): when merging independently, the resulting datasets would probably end up with different overall scaling factors. When comparing the results, you would need to take this difference into account. In practice, most programs can do that job easily, but what about if a B factor is included? And what if partialities are included - how unique is the solution?
-With \fBpartialator --custom-split\fR, you can provide a separate text file containing a list of filenames, event numbers and \fIdataset names\fR, one event (detector frame) per line, with the fields separated by any number of spaces, commas or tabs. For each unique \fIdataset name\fR, a separate reflection list will be output. All crystals will be refined together, but they will be merged according to the dataset names you give. The parameters (scaling factors, partialities etc) determined during the joint refinement will be applied. For each dataset, a separate pair of split half-datasets will also be written, allowing you to calculate figures of merit such as Rsplit and CC1/2 for each one.
+With \fBpartialator --custom-split\fR, you can provide a separate text file containing a list of filenames, event numbers and \fIdataset names\fR, one event (detector frame) per line, with each field separated by exactly one space. For each unique \fIdataset name\fR, a separate reflection list will be output. All crystals will be refined together, but they will be merged according to the dataset names you give. The parameters (scaling factors, partialities etc) determined during the joint refinement will be applied. For each dataset, a separate pair of split half-datasets will also be written, allowing you to calculate figures of merit such as Rsplit and CC1/2 for each one.
If the overall output filename (given with \fB-o\fR or \fB--output\fR) were \fBmerged.hkl\fR, then a dataset named \fIdataset\fR would be written to \fBmerged-\fIdataset\fB.hkl\fR. The corresponding half-datasets would be written to \fBmerged-\fIdataset\fB.hkl1\fR and \fBmerged-\fIdataset\fB.hkl2\fR.