\(\renewcommand\AA{\unicode{x212B}}\)
Table of Contents
Name | Direction | Type | Default | Description |
---|---|---|---|---|
InputWorkspace | Input | MatrixWorkspace | Mandatory | An input workspace with an attached instrument. |
Geometry | Input | Dictionary | A dictionary of geometry parameters for the beam |
Set properties of the beam on a given workspace. Current support is limited to specifying the beam geometry, which sets a Slit (rectangular) or Circular profile, with properties of either width and height, or radius, respectively.
The following Geometry flags are recognised by the algorithm:
wsSlit = CreateSampleWorkspace()
SetBeam(wsSlit, Geometry={'Shape': 'Slit', 'Width': 1.0, 'Height': 0.75})
wsCircle = CreateSampleWorkspace()
SetBeam(wsCircle, Geometry={'Shape': 'Circle', 'Radius': 1.0})
Categories: AlgorithmIndex | Sample
C++ header: SetBeam.h (last modified: 2021-03-31)
C++ source: SetBeam.cpp (last modified: 2021-03-31)