diff options
| author | Thomas White <taw@physics.org> | 2019-08-30 14:37:27 +0200 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2019-09-02 13:14:32 +0200 |
| commit | 1df82f92bb366bac6bb2e7e6e04506b2d22dab0e (patch) | |
| tree | 079d986091833be890bf3861812b5bb3d162383d /doc/man | |
| parent | 77406eb6d3a655364e52f046215fcebe8d873368 (diff) | |
process_hkl,partialator: Allow arbitrary direction and degree of polarisation
Diffstat (limited to 'doc/man')
| -rw-r--r-- | doc/man/partialator.1 | 9 | ||||
| -rw-r--r-- | doc/man/process_hkl.1 | 9 |
2 files changed, 16 insertions, 2 deletions
diff --git a/doc/man/partialator.1 b/doc/man/partialator.1 index f0491616..63b7578e 100644 --- a/doc/man/partialator.1 +++ b/doc/man/partialator.1 @@ -93,9 +93,16 @@ Specify the partiality model. See the list below for possible choices. Run \fIn\fR analyses in parallel. .PD 0 +.IP \fB--polarisation=\fItype\fR +.PD +Specify the polarisation of the incident radiation. \fItype\fR can be \fBhoriz\fR, \fBvert\fR or \fBnone\fR to indicate 100% polarisation of the electric field in the horizontal plane, vertical plane or completely unpolarised radiation respectively. Alternatively, \fItype\fR can be a direction followed by a percentage polarisation fraction. For example, \fB45deg90\fR means that 90% of the radiation is polarised with its electric field in a direction 45 degrees from horizontal, and \fB10deg100\fR means that all the radiation is polarised at 10 degrees from horizontal. The angle is specified clockwise from horizontal as viewed along the beam direction, i.e. as shown by \fBhdfsee\fR. The beam is unpolarised when the fraction is 50% (equal parts of the radiation have their electric field in the specified plane). If the polarisation fraction is 100%, it can be omitted. For example \fB10deg\fR or \fBhoriz\fR. + +The default is \fB--polarisation=horiz\fR. + +.PD 0 .IP \fB--no-polarisation\fR .PD -Disable the polarisation correction. +Synonym for \fB--polarisation=none\fR. .PD 0 .IP \fB--max-adu=\fR\fIn\fR diff --git a/doc/man/process_hkl.1 b/doc/man/process_hkl.1 index 658f42bf..d01cfc5d 100644 --- a/doc/man/process_hkl.1 +++ b/doc/man/process_hkl.1 @@ -84,9 +84,16 @@ Perform a second pass through the input, scaling each crystal's intensities to b Use \fBpartialator\fR if you need more advanced merging techniques. .PD 0 +.IP \fB--polarisation=\fItype\fR +.PD +Specify the polarisation of the incident radiation. \fItype\fR can be \fBhoriz\fR, \fBvert\fR or \fBnone\fR to indicate 100% polarisation of the electric field in the horizontal plane, vertical plane or completely unpolarised radiation respectively. Alternatively, \fItype\fR can be a direction followed by a percentage polarisation fraction. For example, \fB45deg90\fR means that 90% of the radiation is polarised with its electric field in a direction 45 degrees from horizontal, and \fB10deg100\fR means that all the radiation is polarised at 10 degrees from horizontal. The angle is specified clockwise from horizontal as viewed along the beam direction, i.e. as shown by \fBhdfsee\fR. The beam is unpolarised when the fraction is 50% (equal parts of the radiation have their electric field in the specified plane). If the polarisation fraction is 100%, it can be omitted. For example \fB10deg\fR or \fBhoriz\fR. + +The default is \fB--polarisation=horiz\fR. + +.PD 0 .IP \fB--no-polarisation\fR .PD -Disable the polarisation correction. +Synonym for \fB--polarisation=none\fR. .PD 0 .IP \fB--min-measurements=\fR\fIn\fR |