SANSNormalizeToMonitor v1

../_images/SANSNormalizeToMonitor-v1_dlg.png

SANSNormalizeToMonitor dialog.

Summary

Calculates a monitor normalization workspace for a SANS reduction.

Properties

Name Direction Type Default Description
SANSState Input Dictionary   A property manager which fulfills the SANSState contract.
InputWorkspace Input MatrixWorkspace Mandatory The monitor workspace in time-of-flight units.
ScaleFactor Input number 1 Optional scale factor for the input workspace.
OutputWorkspace Output MatrixWorkspace Mandatory A monitor normalization workspace in units of wavelength.

Description

This algorithm provides a monitor normalization workspace for subsequent wavelength correction in Q1D v2 or Qxy v1. The settings of the algorithm are provided by the state object. The user can provide a ScaleFactor which is normally obtained during event slicing.

Currently the mask mechanism is implemented for SANS2D, LOQ and LARMOR.

Relevant SANSState entries for SANSNormalizeToMonitor

The required information for the monitor normalization is retrieved from a state object.

The elements are:

Entry Type Description Mandatory Default
         
prompt_peak_correction_min Float Min time of the prompt peak No None
prompt_peak_correction_max Float Max time of the prompt peak No None
prompt_peak_correction_enabled Bool If using prompt peak correction No False
rebin_type RebinType enum The type of rebinning to be used No Rebin
wavelength_low Float Lower wavelength bound No None
wavelength_high Float Upper wavelength bound No None
wavelength_step Float Wavelength step No None
wavelength_step_type RangeStepType enum Wavelength step type No None
incident_monitor Integer The incident monitor Yes None
background_TOF_general_start Float General background corr. start time No None
background_TOF_general_stop Float General background corr. stop time No None
background_TOF_monitor_start Dict Monitor num vs background corr. start time No None
background_TOF_monitor_stop Dict Monitor num vs background corr. stop time No None

Note that the prompt peak settings are automatically set up for LOQ

Note that these settings should be only populated via the GUI or the Python Interface of ISIS SANS.

Categories: Algorithm Index | SANS\Adjust

Source

Python: SANSNormalizeToMonitor.py (last modified: 2018-10-05)