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

EqualToMD v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Perform the EqualTo boolean operation on two MDHistoWorkspaces

See Also

GreaterThanMD, LessThanMD, NotMD

Properties

Name

Direction

Type

Default

Description

LHSWorkspace

Input

IMDWorkspace

Mandatory

An MDEventWorkspace, MDHistoWorkspace or WorkspaceSingleValue as the left-hand side of the operation.

RHSWorkspace

Input

IMDWorkspace

Mandatory

An MDEventWorkspace, MDHistoWorkspace or WorkspaceSingleValue as the right-hand side of the operation.

OutputWorkspace

Output

IMDWorkspace

Mandatory

Name of the output MDEventWorkspace or MDHistoWorkspace.

Tolerance

Input

number

1e-05

Tolerance when performing the == comparison. Default 10^-5.

Description

Perform the == (equals to) boolean operation on two MDHistoWorkspaces or a MDHistoWorkspace and a scalar. The output workspace has a signal of 0.0 to mean “false” and a signal of 1.0 to mean “true”. Errors are 0.

For two MDHistoWorkspaces, the operation is performed element-by-element. Only the signal is compared.

For a MDHistoWorkspace and a scalar, the operation is performed on each element of the output.

Categories: AlgorithmIndex | MDAlgorithms\MDArithmetic

Source

C++ header: EqualToMD.h

C++ source: EqualToMD.cpp