HFIRDarkCurrentSubtraction v1

../_images/HFIRDarkCurrentSubtraction-v1_dlg.png

HFIRDarkCurrentSubtraction dialog.

Table of Contents

Summary

Perform HFIR SANS dark current subtraction.

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace Mandatory  
Filename Input string Mandatory The name of the input event Nexus file to load as dark current. Allowed extensions: [‘.xml’]
OutputWorkspace Output MatrixWorkspace Mandatory  
PersistentCorrection Input boolean True If true, the algorithm will be persistent and re-used when other data sets are processed
ReductionProperties Input string __sans_reduction_properties  
OutputDarkCurrentWorkspace Output MatrixWorkspace    
OutputMessage Output string    

Description

Subtract the dark current from a HFIR SANS data set. This algorithm is rarely called directly. It is called by HFIRSANSReduction.

This workflow algorithm will:

  • Properly load the dark current data set
  • Normalize the dark current to the data taking period
  • Subtract the dark current from the input workspace

The dark current is subtracted pixel by pixel by normalizing the dark current data by counting time, as follows:

I'(x,y)=I_{data}(x,y)-\frac{T_{data}}{T_{dc}} I_{dc}(x,y)

where the T-values are the counting times for the data set and the dark current (dc).

Categories: AlgorithmIndex | Workflow\SANS\UsesPropertyManager

Source

C++ source: HFIRDarkCurrentSubtraction.cpp (last modified: 2019-06-05)

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