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

CalculateFlux v1¶

../_images/ImageNotFound.png — Enable screenshots using DOCS_SCREENSHOTS in CMake¶

Summary ¶

Calculates the incident beam flux as a function of wavelength using a direct beam SANS data.

Properties ¶

Name	Direction	Type	Default	Description
InputWorkspace	Input	MatrixWorkspace	Mandatory	The input workspace
BeamRadius	Input	number	0.1	The radius of the beam [m]
OutputWorkspace	Output	MatrixWorkspace	Mandatory	The output workspace

Description ¶

Calculates the incident flux using an empty beam measurement for a SANS instrument in reactor sources.

Input must be a workspace corresponding to an empty beam measurement. It needs to have the same number of bins for all the spectra, but it does not have to have exact same axes. The X-axis unit can be either wavelength (for TOF) or dimensionless. In case of TOF, the algorithm will take the global minimum and the global maximum of the wavelengths in the input workspace, and make equidistant bins such that it has the same number of bins as the input. The input has to be already normalised in the same fashion, as the sample workspaces that are going to be normalised with the flux calculated with this algorithm. For example, if the input is normalised by time, the flux will mean number of neutrons per second.

ws = CreateSampleWorkspace(XUnit="Wavelength", NumBanks=1, Function="One Peak")
flux = CalculateFlux(InputWorkspace=ws, BeamRadius=0.05)
print(flux.readY(0)[5])