MayersSampleCorrection v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Corrects the input data for the effects of attenuation & multiple scattering

See Also

MonteCarloAbsorption, CarpenterSampleCorrection

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

Input workspace with X units in TOF. The workspace must also have a sample with a cylindrical shape and an instrument with a defined source and sample position.

MultipleScattering

Input

boolean

False

If True then also correct for the effects of multiple scattering.Please note that the MS correction assumes the scattering is elastic.

MSEvents

Input

number

10000

Controls the number of second-scatter events generated. Only applicable where MultipleScattering=True.

MSRuns

Input

number

10

Controls the number of simulations, each containing MSEvents, performed. The final MS correction is computed as the average over the runs. Only applicablewhere MultipleScattering=True.

OutputWorkspace

Output

MatrixWorkspace

Mandatory

An output workspace.

Description

Calculates and applies corrections due to the effects of absorption (plus optionally multiple scattering) on the signal and error values for a given workspace. The full background to the algorithm is described by Lindley et al. [1] and is briefly described here.

The following assumptions are made:

  • the sample shape is a cylinder

  • for multiple scattering:
    • the scattering is assumed to be elastic and isotropic

    • the ratio of successive orders of scattering are all equal to β(θ,ϕ,E)

The aim is to correct the number of neutrons at a given detector (Nd) to compute the number of neutrons (Nc) that would reach the detector if there was no absorption (or multiple scattering). Ignoring detector efficiency we can write:

Nd=NcAs11β

where As(θ,ϕ,E) is the absorption and self-shielding factor and is computed by numerical integration over the sample cylinder.

The multiple scattering factor (if requested) is computed by simulating over a fixed number of second order scattering events and computing the ratio of second order and first order scattering. Since we have assumed the ratio is the same between successive orders, the 11β factor simply comes from taking the sum of a geometric series.

The cylinder radius r combined with the inverse attenuation length μ=μ(E) (derived from the total scattering cross-section) gives a range of μr against input time-of-flight (“energy”) for the cylinder. The μr range is divided into a discrete number of points for each point.

A weighted least-squares fit is applied to both the set of attenuation and multiple scattering factors to allow interpolation of the correction factor from any time-of-flight value in the input range. For each time-of-flight value the factor is computed from the fit coefficients and the correction applied multiplicatively:

yout=yincorrfacteout=youtein/yin

The above procedure is repeated separately for each spectrum in the workspace.

Usage

Example - Correct Vanadium For Both Absorption & Multiple Scattering

# Create a fake workspace with TOF data
sample_ws = CreateSampleWorkspace(Function='Powder Diffraction',
                                  NumBanks=1,BankPixelWidth=1,XUnit='TOF',
                                  XMin=1000,XMax=10000)
# Set meta data about shape and material
cyl_height_cm = 4.0
cyl_radius_cm = 0.25
material = 'V'
num_density = 0.07261
SetSample(sample_ws,
    Geometry={'Shape': 'Cylinder', 'Height': cyl_height_cm,
              'Radius': cyl_radius_cm, 'Center': [0.0,0.0,0.0]},
    Material={'ChemicalFormula': material, 'SampleNumberDensity': num_density})

# Run corrections
corrected_sample = MayersSampleCorrection(sample_ws,
                                          MultipleScattering=True)

# Print a bin
print("Uncorrected signal: {0:.4f}".format(sample_ws.readY(0)[25]))
print("Corrected signal: {0:.4f}".format(corrected_sample.readY(0)[25]))

Output:

Uncorrected signal: ...
Corrected signal: ...

References

Categories: AlgorithmIndex | CorrectionFunctions\AbsorptionCorrections

Source

C++ header: MayersSampleCorrection.h

C++ source: MayersSampleCorrection.cpp