HFIRSANSNormalise v1

../_images/HFIRSANSNormalise-v1_dlg.png

HFIRSANSNormalise dialog.

Summary

Apply normalisation correction to HFIR SANS data.

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace Mandatory Workspace to be corrected
NormalisationType Input string Monitor Type of Normalisation to use. Allowed values: [‘Monitor’, ‘Timer’]
OutputWorkspace Output MatrixWorkspace Mandatory Corrected workspace
OutputMessage Output string    

Description

Performs data normalisation for HFIR SANS. This algorithm is usually called by HFIRSANSReduction.

According to the NormalisationType property, which can be set to “Monitor” or “Timer”, the algorithm will retrieve the corresponding value and scale the input workspace by it.

Usage

Note

To run these usage examples please first download the usage data, and add these to your path. In MantidPlot this is done using Manage User Directories.

Example - Normalise a BioSANS data set to time:

workspace = HFIRLoad('BioSANS_empty_cell.xml')
workspace = HFIRSANSNormalise(InputWorkspace='workspace', NormalisationType="Timer")

Categories: AlgorithmIndex | Workflow\SANS

Source

C++ source: HFIRSANSNormalise.cpp (last modified: 2019-07-17)

C++ header: HFIRSANSNormalise.h (last modified: 2018-10-05)