ISISIndirectEnergyTransfer v1

Summary

Runs an energy transfer reduction for an inelastic indirect geometry instrument.

See Also

This algorithm is also known as: ISISIndirectEnergyTransferWrapper

Properties

Name	Direction	Type	Default	Description
InputFiles	Input	str list		Comma separated list of input files
SumFiles	Input	boolean	False	Toggle input file summing or sequential processing
LoadLogFiles	Input	boolean	True	Load log files when loading runs
CalibrationWorkspace	Input	Workspace		Workspace containing calibration data
Instrument	Input	string	Mandatory	Instrument used during run. Allowed values: [‘IRIS’, ‘OSIRIS’, ‘TOSCA’, ‘TFXA’]
Analyser	Input	string	Mandatory	Analyser bank used during run. Allowed values: [‘graphite’, ‘mica’, ‘fmica’, ‘silicon’]
Reflection	Input	string	Mandatory	Reflection number for instrument setup during run. Allowed values: [‘002’, ‘004’, ‘006’, ‘111’, ‘333’]
Efixed	Input	number	Optional	Overrides the default Efixed value for the analyser/reflection selection.
SpectraRange	Input	int list	0,1	Comma separated range of spectra number to use.
BackgroundRange	Input	dbl list		Range of background to subtract from raw data in time of flight.
RebinString	Input	string		Rebin string parameters.
DetailedBalance	Input	number	Optional
ScaleFactor	Input	number	1	Factor by which to scale result.
FoldMultipleFrames	Input	boolean	True	Folds multiple framed data sets into a single workspace.
GroupingMethod	Input	string	IPF	The method used to group detectors. Allowed values: [‘Individual’, ‘All’, ‘File’, ‘Workspace’, ‘IPF’, ‘Custom’, ‘Groups’, ‘Detectors’, ‘ThetaGroups’]
GroupingWorkspace	Input	Workspace		A workspace containing a detector grouping.
GroupingString	Input	string		Detectors to group as a string
MapFile	Input	string		This property is deprecated (since v6.10), please use the ‘GroupingFile’ property instead. Allowed extensions: [‘.map’]
GroupingFile	Input	string		A file containing a detector grouping. Allowed extensions: [‘.map’]
NGroups	Input	number	1	The number of groups for grouping the detectors.
UnitX	Input	string	DeltaE	X axis units for the result workspace. Allowed values: [‘DeltaE’, ‘DeltaE_inWavenumber’]
OutputWorkspace	Output	WorkspaceGroup	Mandatory	Workspace group for the resulting workspaces.
OutputSuffix	Input	string		A suffix that will be appended to each output workspace while preserving the naming convention

Description

Performs a reduction from raw time of flight to energy transfer for an inelastic indirect geometry instrument at ISIS.

OSIRIS silicon analyser data are supported for the 111 and 333 reflections. The default spectrum range and rebinning are obtained from the selected instrument parameter file. For silicon reductions, unreliable edge pixels are excluded before calibration and reduction. When a calibration workspace is supplied, spectra removed from that workspace are also excluded from the sample reduction.

The Detectors grouping method groups the remaining silicon pixels tube by tube using the supplied OSIRIS grouping file. ThetaGroups divides the fixed \(2\theta\) range defined by the instrument parameter file’s theta-min and theta-max parameters (in degrees) into NGroups equal-width angular bins. Both OSIRIS silicon reflections use limits of 8 and 163 degrees. Masking, removing edge pixels or selecting a narrower SpectraRange does not change these boundaries. Spectra outside the angular limits are excluded, and empty bins are omitted from the output. Both outer limits are included; a spectrum exactly on an internal boundary belongs to the lower-angle bin.

Workflow

Usage

Note

To run these usage examples please first download the usage data, and add these to your path. In Mantid this is done using Manage User Directories.

Example - IRIS energy conversion

ISISIndirectEnergyTransfer(InputFiles='IRS21360.raw',
                           OutputWorkspace='IndirectReductions',
                           Instrument='IRIS',
                           Analyser='graphite',
                           Reflection='002',
                           SpectraRange=[3, 53])

reduction_workspace_names = mtd['IndirectReductions'].getNames()

for workspace_name in reduction_workspace_names:
   print(workspace_name)

Output:

iris21360_graphite002_red

Categories: AlgorithmIndex | Workflow\Inelastic | Inelastic\Indirect

Source

Python: ISISIndirectEnergyTransfer.py