\(\renewcommand\AA{\unicode{x212B}}\)

EnergyWindowScan v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

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

Properties

Name

Direction

Type

Default

Description

InputFiles

Input

str list

Comma separated list of input files

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

Analyser

Input

string

Mandatory

Analyser bank used during run. Allowed values: [‘graphite’, ‘mica’, ‘fmica’]

Reflection

Input

string

Mandatory

Reflection number for instrument setup during run. Allowed values: [‘002’, ‘004’, ‘006’]

SpectraRange

Input

long list

0,1

Comma separated range of spectra number to use.

ElasticRange

Input

dbl list

Energy range for the elastic component.

InelasticRange

Input

dbl list

Energy range for the inelastic component.

TotalRange

Input

dbl list

Energy range for the total energy component.

DetailedBalance

Input

number

Optional

Apply the detailed balance correction

GroupingMethod

Input

string

Individual

Method used to group spectra. Allowed values: [‘Individual’, ‘All’, ‘File’, ‘Workspace’, ‘IPF’]

GroupingWorkspace

Input

Workspace

Workspace containing spectra grouping.

MapFile

Input

string

File containing spectra grouping. Allowed extensions: [‘.map’]

SampleEnvironmentLogName

Input

string

sample

Name of the sample environment log entry

SampleEnvironmentLogValue

Input

string

last_value

Value selection of the sample environment log entry. Allowed values: [‘last_value’, ‘average’]

MSDFit

Input

boolean

False

Perform an MSDFit

SumFiles

Input

boolean

False

Toggle input file summing or sequential processing

ReducedWorkspace

Input

string

Reduced

Workspace group for the resulting workspaces.

ScanWorkspace

Input

string

Scan

Workspace for the scan results.

Description

Performs a data reduction from ISISIndirectEnergyTransfer, before performing the ElasticWindowMultiple algorithm over the elastic and inelastic regions of the reduced data to calculate the elastic incoherent scattering factor. There is also an option to perform the MSDFit algorithm.

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 Window Scan

EnergyWindowScan(InputFiles="IRS21360.RAW", Instrument='IRIS', Analyser='graphite',
                         Reflection='002', SpectraRange='3, 50', ElasticRange='-0.5, 0',
                         InelasticRange='0, 0.5', GroupingMethod='Individual', MSDFit=True)

Categories: AlgorithmIndex | Workflow\Inelastic | Inelastic\Indirect | Workflow\MIDAS

Source

Python: EnergyWindowScan.py