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

DirectILLSelfShielding v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Calculates self-shielding correction for the direct geometry TOF spectrometers at ILL.

See Also

DirectILLApplySelfShielding, DirectILLReduction

Properties

Name	Direction	Type	Default	Description
InputWorkspace	Input	MatrixWorkspace		A workspace for which to simulate the self shielding.
OutputWorkspace	Output	MatrixWorkspace	Mandatory	A workspace containing the self shielding correction factors.
Cleanup	Input	string	Cleanup ON	What to do with intermediate workspaces. Allowed values: [‘Cleanup ON’, ‘Cleanup OFF’]
SubalgorithmLogging	Input	string	Logging OFF	Enable or disable subalgorithms to print in the logs. Allowed values: [‘Logging OFF’, ‘Logging ON’]
SimulationInstrument	Input	string	Sparse Instrument	Select if the simulation should be performed on full or approximated instrument. Allowed values: [‘Sparse Instrument’, ‘Full Instrument’]
SparseInstrumentRows	Input	long	5	Number of detector rows in sparse simulation instrument.
SparseInstrumentColumns	Input	long	20	Number of detector columns in sparse simulation instrument.
NumberOfSimulatedWavelengths	Input	long	Optional	Number of wavelength points where the simulation is performed (no longer used).
EventsPerPoint	Input	long	300	The number of neutron events to simulate per wavelength point.

Description

This algorithm calculates self shielding correction factors for the input workspace. It is part of ILL’s direct geometry reduction suite. InputWorkspace should have a sample defined using SetSample. Beam profile can be optionally set using SetBeam. The algorithm uses MonteCarloAbsorption as its backend.

To speed up the simulation, the sparse instrument option of MonteCarloAbsorption is used by default. The number of detectors to simulate can be given by SparseInstrumentRows and SparseInstrumentColumns.

The correction factors are calculated for each bin.

The correction factor contained within the OutputWorkspace can be further fed to DirectILLApplySelfShielding.

Usage

For usage of this algorithm, check the examples here.

Categories: AlgorithmIndex | ILL\Direct | Inelastic\Reduction | Workflow\Inelastic

Source

Python: DirectILLSelfShielding.py