MaskDetectorsInShape
From MantidProject
Contents |
Summary
Masks detectors that are contained within a user defined 3 dimensional shape within the instrument.
Properties
| Order | Name | Direction | Type | Default | Description |
|---|---|---|---|---|---|
| 1 | Workspace | Input | Workspace | Mandatory | The input workspace. |
| 2 | ShapeXML | Input | string | Mandatory | The XML definition of the user defined shape. HowToDefineGeometricShape provides a description of the syntax. |
| 3 | IncludeMonitors | Input | Boolean | Default false | Whether monitors should be included if they are contained in the shape. |
Description
The algorithm places the user defined geometric shape within the virtual instrument and masks any detector detectors that in contained within it. A detector is considered to be contained it its central location point is contained within the shape.
Subalgorithms used
MaskDetectorsInShape runs the following algorithms as child algorithms:
- FindDetectorsInShape - To determine the detectors that are contained in the user defined shape.
- MaskDetectors - To mask the detectors found.
Source Code
Header MaskDetectorsInShape.h
Source MaskDetectorsInShape.cpp
