ReflectometrySumInQ v1¶
Summary¶
Sum counts in lambda along lines of constant Q by projecting to virtual lambda at a reference angle.
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
InputWorkspace |
Input |
Mandatory |
A workspace in X units of wavelength to be summed. |
|
InputWorkspaceIndexType |
Input |
string |
The type of indices in the optional index set; For optimal performance WorkspaceIndex should be preferred;. Allowed values: [‘WorkspaceIndex’, ‘SpectrumNumber’] |
|
InputWorkspaceIndexSet |
Input |
int list |
An optional set of spectra that will be processed by the algorithm; If not set, all spectra will be processed; The indices in this list can be workspace indices or possibly spectrum numbers, depending on the selection made for the index type; Indices are entered as a comma-separated list of values, and/or ranges; For example, ‘4,6,10-20,1000’; |
|
OutputWorkspace |
Output |
Mandatory |
A single histogram workspace containing the result of summation in Q. |
|
BeamCentre |
Input |
number |
Mandatory |
Fractional workspace index of the specular reflection centre. |
FlatSample |
Input |
boolean |
True |
If true, the summation is handled as the standard divergent beam case, otherwise as the non-flat sample case. |
IncludePartialBins |
Input |
boolean |
False |
If true, use the full projected wavelength range possibly including partially filled bins. |
Description¶
This algorithm sums the Y values of histograms given by
InputWorkspaceIndexSet into a single single histogram. The summation is done
using the method proposed by Cubitt et al. [1] This involves a
projection to an arbitrary reference angle,
Counts are considered to be spread evenly over the input pixel, and the
top-left and bottom-right corner of the pixel are projected onto
The input workspace should have wavelength as the X units as well as an instrument.
To produce a reflectivity, the input workspace has to be the reflected beam workspace where each histogram is individually divided by the summed (in lambda) direct beam data.
Usage¶
Example - basic usage with reflectometry-like data

Enable :plots: using DOCS_PLOTDIRECTIVE in CMake
References¶
Categories: AlgorithmIndex | Reflectometry | ILL\Reflectometry
Source¶
C++ header: ReflectometrySumInQ.h
C++ source: ReflectometrySumInQ.cpp