LoadDspacemap v1

../_images/LoadDspacemap-v1_dlg.png

LoadDspacemap dialog.

Summary

Loads a Dspacemap file (POWGEN binary, VULCAN binary or ascii format) into an OffsetsWorkspace.

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 The DspacemapFile containing the d-space mapping. Allowed extensions: [‘.dat’, ‘.bin’]
FileType Input string POWGEN The type of file being read. Allowed values: [‘POWGEN’, ‘VULCAN-ASCII’, ‘VULCAN-Binary’]
OutputWorkspace Output OffsetsWorkspace   An output OffsetsWorkspace.

Description

Loads a Dspacemap file (POWGEN binary, VULCAN binary or ascii format) into an OffsetsWorkspace.

The resulting workspace can then be used with, e.g. AlignDetectors to perform calibration.

Usage

This algorithm is SNS specific in its use.

Note

To run these usage examples please first download the usage data, and add these to your path. In MantidPlot this is done using Manage User Directories.

ws = LoadDspacemap(InstrumentName="VULCAN", Filename="pid_offset_vulcan_new.dat",
                   FileType="VULCAN-ASCII")
print("Workspace type = {}".format(ws.id()))

Output:

Workspace type = OffsetsWorkspace

Categories: AlgorithmIndex | DataHandling\Text

Source

C++ source: LoadDspacemap.cpp (last modified: 2019-06-05)

C++ header: LoadDspacemap.h (last modified: 2018-10-05)