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

PelicanCrystalProcessing v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Performs crystal processing for ANSTO Pelican data.

Properties

Name

Direction

Type

Default

Description

SampleRuns

Input

str list

Mandatory

Comma separated range of sample runs, eg [cycle::] 7333-7341,7345

EmptyRuns

Input

string

Optional path followed by comma separated range of runs, looking for runs in the sample folder if path not included, eg [cycle::] 6300-6308

ScaleEmptyRuns

Input

number

1

Scale the empty runs prior to subtraction

CalibrationRuns

Input

string

Optional path followed by comma separated range of runs, looking for runs in the sample folder if path not included, eg [cycle::] 6350-6365

EmptyCalibrationRuns

Input

string

Optional path followed by comma separated range of runs, looking for runs in the sample folder if path not included, eg [cycle::] 6370-6375

EnergyTransfer

Input

string

0.0, 0.02, 3.0

Energy transfer range in meV expressed as min, step, max

MomentumTransfer

Input

string

Momentum transfer range in inverse Angstroms, expressed as min, step, max. Default estimates the max range based on energy transfer.

LambdaOnTwoMode

Input

boolean

False

Set if instrument running in lambda on two mode.

FrameOverlap

Input

boolean

False

Set if the energy transfer extends over a frame.

CalibrateTOF

Input

boolean

False

Determine the TOF correction from the elastic peak in the data.

TOFCorrection

Input

string

The TOF correction in usec that aligns the elastic peak.

AnalyseTubes

Input

string

Detector tubes to be used in the data analysis.

MaxEnergyGain

Input

string

Energy gain in meV used to adjust the min TOF with frame overlap.

FixedDetector

Input

boolean

True

Fix detector positions to the first run

OutputFolder

Input

string

Mandatory

Path to save the output nxspe files.

ScratchFolder

Input

string

Path to save and restore merged workspaces.

ConfigurationFile

Input

string

Optional: INI file to override default processing values. Allowed values: [‘ini’]

KeepReducedWorkspace

Input

boolean

False

Keep the last reduced workspace.

Description

Performs the reduction of pelican data from event data (two theta, time) to S(Q,w) for single crystal data. The algorithm will sequentially perform the PelicanReduction processing for all run numbers provided. The data is output in nxspe format and can be used by programs such as Horace to process single crystal inelastic neutron scattering data.

Source

Python: PelicanCrystalProcessing.py

Categories: AlgorithmIndex | Workflow