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’]

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.

Workflow#

../_images/ISISIndirectEnergyTransfer-v1_wkflw.svg

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