LoadInstrument

From MantidProject

Contents 1 Summary 2 Properties 3 Introduction 4 Source Code

Summary

Loads an Instrument Definition File (IDF) into a workspace. After the IDF has been read this algorithm will attempt to run the sub-algorithm LoadParameterFile; where if IDF filename is of the form IDENTIFIER_Definition.xml then the instrument parameters in the file named IDENTIFIER_Parameters would be loaded (in the directory specified by the parameterDefinition.directory Mantid property).

Properties

Order	Name	Direction	Type	Default	Description
1	Workspace	Input	Workspace	Mandatory	The name of the workspace to load the instrument definition into.
2	Filename	Input	string	Mandatory	The filename (including its full or relative path) of an instrument defintion file. The file extension must either be .xml or .XML when specifying an instrument definition file.
3	MonitorList	Output	Integer array	Empty	List of detector ids of monitors loaded in to the workspace.

Introduction

Loads an instrument definition file (IDF) into a workspace, which contains information about detector positions, their geometric shape, slit properties, links between values stored in ISIS log-files and components of the instrument and so on. For more on IDFs see: InstrumentDefinitionFile.

Source Code

Header LoadInstrument.h

Source LoadInstrument.cpp