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

PDToGUDRUN v1

Summary

The algorithm used converting raw data to gudrun input files

See Also

PDToPDFgetN

Properties

Name

Direction

Type

Default

Description

Filename

Input

string

Event file. Allowed extensions: [‘_event.nxs’, ‘.nxs.h5’]

MaxChunkSize

Input

number

0

Specify maximum Gbytes of file to read in one chunk. Default is whole file.

FilterBadPulses

Input

number

95

Filter out events measured while proton charge is more than 5% below average

InputWorkspace

Input

MatrixWorkspace

Handle to reduced workspace

OutputWorkspace

Output

MatrixWorkspace

Mandatory

Handle to reduced workspace

GUDRUNFile

Input

string

Mandatory

Output filename. Allowed extensions: [‘.getn’]

GroupingFile

Input

string

Override grouping found in CalibrationFile. Allowed extensions: [‘.xml’]

CalibrationFile

Input

string

Allowed extensions: [‘.h5’, ‘.hd5’, ‘.hdf’, ‘.cal’]

CharacterizationRunsFile

Input

string

File with characterization runs denoted. Allowed extensions: [‘.txt’]

RemovePromptPulseWidth

Input

number

0

Width of events (in microseconds) near the prompt pulse to remove. 0 disables

CropWavelengthMin

Input

number

0

Crop the data at this minimum wavelength.

CropWavelengthMax

Input

number

0

Crop the data at this maximum wavelength.

Binning

Input

dbl list

0,0,0

Positive is linear bins, negative is logorithmic

ResampleX

Input

number

0

Number of bins in x-axis. Non-zero value overrides “Params” property. Negative value means logorithmic binning.

SetUncertainties

Input

string

Recalculate uncertainties. Empty string is do nothing. Allowed values: [‘’, ‘zero’, ‘sqrt’, ‘sqrtOrOne’, ‘oneIfZero’]

Description

This is a workflow algorithm that creates files suitable as input into GUDRUN.

  1. PDLoadCharacterizations v1

  2. LoadEventAndCompress v1 if InputWorkspace is not provided

  3. PDDetermineCharacterizations v1 to determine information from the characterization file

  4. AlignAndFocusPowder v1

  5. NormaliseByCurrent v1

  6. SetUncertainties v1 if SetUncertainties is specified

  7. SaveNexusPD v1

Workflow

../_images/PDToGUDRUN-v1_wkflw.svg

Categories: AlgorithmIndex | Workflow\Diffraction

Source

Python: PDToGUDRUN.py