LoadDiffCal v1

../_images/LoadDiffCal-v1_dlg.png

LoadDiffCal dialog.

Table of Contents

Summary

Loads a calibration file for powder diffraction

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace   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’]
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.

Description

This algorithm loads a diffraction calibration workspace, MaskWorkspace, and GroupingWorkspace from a hdf5 file.

Categories: Algorithms | DataHandling\Instrument | Diffraction\DataHandling

Source

C++ source: LoadDiffCal.cpp

C++ header: LoadDiffCal.h