\(\renewcommand\AA{\unicode{x212B}}\)

CombinePeaksWorkspaces v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Combines the sets of peaks in two peaks workspaces, optionally omitting duplicates.

See Also

CreatePeaksWorkspace

Properties

Name	Direction	Type	Default	Description
LHSWorkspace	Input	IPeaksWorkspace	Mandatory	The first set of peaks.
RHSWorkspace	Input	IPeaksWorkspace	Mandatory	The second set of peaks.
OutputWorkspace	Output	IPeaksWorkspace	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

Description

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 or LeanElasticPeaksWorkspace). 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.

A PeaksWorkspace can be combined with a LeanElasticPeaksWorkspace only if the LHSWorkspace is the LeanElasticPeaksWorkspace in which case all peaks are converted into LeanElasticPeak.

Categories: AlgorithmIndex | Crystal\Peaks

Source

C++ header: CombinePeaksWorkspaces.h

C++ source: CombinePeaksWorkspaces.cpp