3.8

SetBeam v1

../_images/SetBeam-v1_dlg.png

SetBeam dialog.

Summary

Set properties of the beam such as size and shape

Properties

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

Description

Set properties of the beam on a given workspace. Current support is limited to specifying the beam geometry and only supports a slit geometry with given width and height.

Geometry Flags

The following Geometry flags are recognised by the algorithm:

  • Shape: A string indicating the geometry type. Only supports Slit.
  • Height: Height of the slit in centimeters
  • Width: Width of the slit in centimeters

Usage

ws = CreateSampleWorkspace()
SetBeam(ws, Geometry={'Shape': 'Slit', 'Width': 1.0, 'Height': 0.75})

Categories: Algorithms | Sample

Source

C++ source: SetBeam.cpp

C++ header: SetBeam.h