6.4

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

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, which sets a Slit (rectangular) or Circular profile, with properties of either width and height, or radius, respectively.

Geometry Flags

The following Geometry flags are recognised by the algorithm:

  • Shape: A string indicating the geometry type. Supports Slit and Circle.
  • Height: Height of the slit in centimeters. Required for the Slit setting.
  • Width: Width of the slit in centimeters. Required for the Slit setting.
  • Radius: Radius of the circle in centimeters. Required for the Circle setting.

Usage

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

Source

C++ header: SetBeam.h

C++ source: SetBeam.cpp