5.1

CalculateDIFC v1

../_images/CalculateDIFC-v1_dlg.png

CalculateDIFC dialog.

Summary

Calculate the DIFC for every pixel

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace Mandatory Name of the workspace to have DIFC calculated from
OutputWorkspace Output MatrixWorkspace Mandatory Workspace containing DIFC for each pixel
CalibrationWorkspace Input TableWorkspace   Optional: A OffsetsWorkspace containing the calibration offsets. This cannot be specified with an OffsetsWorkspace.
OffsetsWorkspace Input OffsetsWorkspace   Optional: A OffsetsWorkspace containing the calibration offsets. This cannot be specified with a CalibrationWorkspace.

Description

CalculateDIFC calculates the value of DIFC for every pixel in an instrument.

DIFC = \frac{m_n}{h} \frac{(L_1 + L_2) 2 \sin(\theta)}{1 + {offset}}

This is used in the equation

TOF = DIFC \times d

This algorithm uses the same underlying calculation as ConvertUnits v1 and AlignDetectors v1.

When specifying the CalibrationWorkspace, this algorithm uses the values in the detid and difc columns of the calibration only. It ignores any other calibration constants.

Assumptions: There are no assumptions and this algorithm works on the results of LoadEmptyInstrument v1.

Usage

Example - CalculateDIFC

ws = LoadEmptyInstrument(Filename="NOMAD_Definition.xml", OutputWorkspace="ws")
ws = CalculateDIFC(ws, OutputWorkspace="ws")

# Print the result
print("The output workspace has {} spectra".format(ws.getNumberHistograms()))
print("DIFC of pixel {} is {:.0f}".format(100, ws.readY(100)[0]))

Output:

The output workspace has 101376 spectra
DIFC of pixel 100 is 1228

Determining traditional offsets

ws = LoadEmptyInstrument(Filename="NOMAD_Definition.xml", OutputWorkspace="ws")
LoadDiffCal(InputWorkspace=ws, Filename='NOM_cal.h5', WorkspaceName='NOM')
uncalibrated = CalculateDIFC(ws, OutputWorkspace="uncalibrated")
calibrated = CalculateDIFC(ws, CalibrationWorkspace="NOM_cal", OutputWorkspace="calibrated")

offsets = calibrated/uncalibrated - 1.

Categories: AlgorithmIndex | Diffraction\Utility

Source

C++ header: CalculateDIFC.h (last modified: 2020-03-20)

C++ source: CalculateDIFC.cpp (last modified: 2020-04-07)