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

DgsRemap v1

Summary

Mask and/or group the given workspace.

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

An input workspace to mask and group.

MaskWorkspace

Input

MatrixWorkspace

A workspace containing masking information.

GroupingWorkspace

Input

MatrixWorkspace

A workspace containing grouping information

OldGroupingFile

Input

string

Name of an old grouping format (not XML) file.

ExecuteOppositeOrder

Input

boolean

False

Execute grouping before masking.

OutputWorkspace

Output

MatrixWorkspace

Mandatory

The resulting workspace.

Description

This algorithm is responsible for masking and grouping the given input workspace. One can use the ExecuteOppositeOrder to do grouping first then masking.

Workflow

../_images/DgsRemap-v1_wkflw.svg

Usage

Warning

This algorithm is not really intended for use at the command line, but is used within DgsReduction.

Categories: AlgorithmIndex | Workflow\Inelastic

Source

C++ header: DgsRemap.h

C++ source: DgsRemap.cpp