\(\renewcommand\AA{\unicode{x212B}}\)
LoadDiffCal v1¶
![../_images/LoadDiffCal-v1_dlg.png](../_images/LoadDiffCal-v1_dlg.png)
LoadDiffCal dialog.¶
Summary¶
Loads a calibration file for powder diffraction
See Also¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
InputWorkspace |
Input |
Optional: An input workspace with the instrument we want to use. |
||
InstrumentName |
Input |
string |
Optional: Name of the instrument to base the GroupingWorkspace on which to base the GroupingWorkspace. |
|
InstrumentFilename |
Input |
string |
Optional: Path to the instrument definition file on which to base the GroupingWorkspace. Allowed extensions: [‘.xml’] |
|
Filename |
Input |
string |
Mandatory |
Path to the .h5 file. Allowed extensions: [‘.h5’, ‘.hd5’, ‘.hdf’, ‘.cal’] |
GroupFilename |
Input |
string |
Overrides grouping from CalFileName. Allowed extensions: [‘.xml’, ‘.cal’] |
|
MakeGroupingWorkspace |
Input |
boolean |
True |
Set to true to create a GroupingWorkspace with called WorkspaceName_group. |
MakeCalWorkspace |
Input |
boolean |
True |
Set to true to create a CalibrationWorkspace with called WorkspaceName_cal. |
MakeMaskWorkspace |
Input |
boolean |
True |
Set to true to create a MaskWorkspace with called WorkspaceName_mask. |
WorkspaceName |
Input |
string |
The base of the output workspace names. Names will have ‘_group’, ‘_cal’, ‘_mask’ appended to them. |
|
TofMin |
Input |
number |
0 |
Minimum for TOF axis. Defaults to 0. |
TofMax |
Input |
number |
Optional |
Maximum for TOF axis. Defaults to Unused. |
FixConversionIssues |
Input |
boolean |
True |
Set DIFA and TZERO to zero if there is an error and the pixel is masked |
Description¶
This algorithm creates up to three workspaces from a hdf5 file:
diffraction calibration workspace contains information on converting from time-of-flight to d-spacing
MaskWorkspace
contains which pixels to use (by deleting the unused ones)GroupingWorkspace
describes which pixels get added together by DiffractionFocussing v2
Categories: AlgorithmIndex | DataHandling\Instrument | Diffraction\DataHandling
Source¶
C++ header: LoadDiffCal.h
C++ source: LoadDiffCal.cpp