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

DiffPeaksWorkspaces v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Removes from a workspace any peaks that match a peak in a second workspace.

See Also

CreatePeaksWorkspace, CombinePeaksWorkspaces

Properties

Name

Direction

Type

Default

Description

LHSWorkspace

Input

PeaksWorkspace

Mandatory

The first of peaks.

RHSWorkspace

Input

PeaksWorkspace

Mandatory

The second set of peaks.

OutputWorkspace

Output

PeaksWorkspace

Mandatory

The set of peaks that are in the first, but not the second, workspace.

Tolerance

Input

number

0

Maximum difference in each component of Q for which peaks are considered identical

Description

This algorithm takes an input workspace (the LHSWorkspace) and removes from it’s list of peaks any that are also found in a second workspace (the RHSWorkspace) in the same position in Q space within the specified tolerance. Each peak in the RHSWorkspace is taken in turn and compared to each peak in the LHSWorkspace in turn. The first match encountered is used, and the matching peak removed from the output before moving onto the next RHSWorkspace peak.

Categories: AlgorithmIndex | Crystal\Peaks

Source

C++ header: DiffPeaksWorkspaces.h

C++ source: DiffPeaksWorkspaces.cpp