CombinePeaksWorkspaces dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| LHSWorkspace | Input | PeaksWorkspace | Mandatory | The first set of peaks. |
| RHSWorkspace | Input | PeaksWorkspace | Mandatory | The second set of peaks. |
| OutputWorkspace | Output | PeaksWorkspace | Mandatory | The combined peaks list. |
| CombineMatchingPeaks | Input | boolean | False | Whether to combine peaks that are identical across the two workspaces |
| Tolerance | Input | number | Optional | Maximum difference in each component of Q for which peaks are considered identical |
This algorithm can be used to combine lists of single crystal peaks, possibly obtained by different methods, in to a single list (contained in a PeaksWorkspace). With the default options, this will simply append the lists of peaks. If CombineMatchingPeaks is selected then an attempt will be made to identify identical peaks by matching them in Q within the specified tolerance. The peaks in each workspace are traversed in the order they are found in the workspace (RHSWorkspace first) and if a match is found (the search stops at the first match for each RHSWorkspace peak) then the peak in the LHSWorkspace is retained.
Categories: AlgorithmIndex | Crystal\Peaks
C++ source: CombinePeaksWorkspaces.cpp (last modified: 2019-06-05)
C++ header: CombinePeaksWorkspaces.h (last modified: 2018-10-05)