DirectILLSelfShielding dialog.
Table of Contents
| 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 | number | 5 | Number of detector rows in sparse simulation instrument. |
| SparseInstrumentColumns | Input | number | 20 | Number of detector columns in sparse simulation instrument. |
| NumberOfSimulatedWavelengths | Input | number | Optional | Number of wavelength points where the simulation is performed (default: all). |
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.
By default the correction factors are calculated for each bin. By specifying NumberOfSimulatedWavelengths, one can restrict the number of points at which the calculation is done thus reducing the execution time. In this case CSplines are used to interpolate the correction factor over all bins.
The correction factor contained within the OutputWorkspace can be further fed to DirectILLApplySelfShielding.
For usage of this algorithm, check the examples here.
Categories: AlgorithmIndex | ILL\Direct | Inelastic\Reduction | Workflow\Inelastic
Python: DirectILLSelfShielding.py (last modified: 2019-03-11)