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

DgsProcessDetectorVanadium v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Algorithm to process detector vanadium.

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

An input workspace containing the detector vanadium data in TOF units.

InputMonitorWorkspace

Input

MatrixWorkspace

A monitor workspace associated with the input workspace.

MaskWorkspace

Input

MatrixWorkspace

A mask workspace

OutputWorkspace

Output

MatrixWorkspace

Mandatory

The name for the output workspace.

ReductionProperties

Output

string

Description

This algorithm is responsible for processing the detector vanadium in the form required for the sample data normalisation in the convert to energy transfer process. Parameters in italics are controlled by the instrument parameter file (IPF) unless provided to the algorithm via a property manager. The mappings are given below.

Parameter

IPF Mapping

DetVanIntRangeLow

wb-integr-min

DetVanIntRangeHigh

wb-integr-max

Parameters in italics with dashed perimeters are only controllable by the IPF name given. All underlined parameters are fixed and not controllable. If the input detector vanadium is in TOF units and that is the requested units for integration, the ConvertUnits algorithm does not run. The range parameters feeding into Rebin are used to make a single bin. The resulting integrated vanadium workspace can be saved to a file using the reduction property manager with the boolean property SaveProcessedDetVan.

Workflow

DgsProcessDetectorVanadiumWorkflow.png

Usage

Warning

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

Categories: AlgorithmIndex | Workflow\Inelastic\UsesPropertyManager

Source

C++ header: DgsProcessDetectorVanadium.h

C++ source: DgsProcessDetectorVanadium.cpp