VesuvioTransmission v1

Summary

This algorithm evaluates the transmission spectrum on the VESUVIO spectrometer for measured sample and empty run numbers.

Properties

Name	Direction	Type	Default	Description
OutputWorkspace	Output	MatrixWorkspace	Mandatory	Output transmission workspace
Runs	Input	string	Mandatory	Sample run number, comma/list expression, or range for TimeScan, e.g. ‘12345-12355’.
EmptyRuns	Input	string	Mandatory	Empty-can/empty-cell run number or run expression.
Grouping	Input	string	SumOfAllRuns	Either sum all sample runs, or append one transmission spectrum per run in a run range. Allowed values: [‘TimeScan’, ‘SumOfAllRuns’]
Target	Input	string	Energy	Target unit for the final transmission spectrum. Allowed values: [‘Energy’, ‘Wavelength’]
Rebin	Input	boolean	False	If rebin is true, rebin the final summed transmission spectrum
RebinParameters	Input	dbl list	0.6,-0.005,1e+07	Mantid Rebin parameters list, e.g. ‘[0.6,-0.005,1.e7]’. Used for Energy target only.
CalculateXS	Input	boolean	False	If true, also calculate a normalised effective cross-section workspace named ‘<OutputWorkspace>_XS’.
InvertMonitors	Input	boolean	False	If true, invert the monitor ratio used to form the transmission.
SmoothIncidentSpectrum	Input	boolean	False	If true, apply SmoothData with NPoints=5 to the incident monitor spectrum before division.

Description

Evaluates the transmission spectrum on the VESUVIO spectrometer for measured sample and empty run numbers.

Usage

Example - VesuvioTransmission

# Run algorithm
VesuvioTransmission(
   OutputWorkspace = "ws_transmission",
   Runs = "58386-58396",
   EmptyRuns = "57580-57603",
   Grouping = "SumOfAllRuns",
   Target = "Energy",
   Rebin = True,
   RebinParameters = [0.6,-0.03,1.e6],
   CalculateXS = False,
   InvertMonitors = False,
   SmoothIncidentSpectrum = False,
)

# Test output
print(f"The output workspace contains {mtd['ws_transmission'].getNumberHistograms()} spectrum and {mtd['ws_transmission'].blocksize()} bins.")

Output:

 The output workspace contains 1 spectrum and 484 bins.

Categories: AlgorithmIndex | Inelastic\Indirect\Vesuvio

Source

Python: VesuvioTransmission.py