CheckWorkspacesMatch

From MantidProject

Contents 1 Summary 2 Properties 3 Description 4 Source Code

Summary

Compares two workspaces for equality. This algorithm is mainly intended for use by the Mantid development team as part of the testing process.

Properties

Order	Name	Direction	Type	Default	Description
1	Workspace1	Input	MatrixWorkspace	Mandatory	The name of the first input workspace.
2	Workspace1	Input	MatrixWorkspace	Mandatory	The name of the second input workspace.
3	Tolerance	Input	double	0.0	The maximum amount by which values may differ between the workspaces.
4	CheckAxes	Input	boolean	true	Whether to check that the axes match.
5	CheckSpectraMap	Input	boolean	true	Whether to check that the spectra-detector maps match.
6	CheckInstrument	Input	boolean	true	Whether to check that the instruments match.
7	CheckMasking	Input	boolean	true	Whether to check that the bin masking matches.
8	Result	Output	string		Will contain 'success' if the workspaces match, the reason for the failure otherwise.

Description

Compares two workspaces for equality. This algorithm is mainly intended for use by Mantid developers as part of the testing process.

The data values (X,Y and error) are always checked. The algorithm can also optionally check the axes (this includes the units), the spectra-detector map, the instrument (the name and parameter map) and any bin masking.

Source Code

Header CheckWorkspacesMatch.h

Source CheckWorkspacesMatch.cpp