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

LoadParameterFile v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Loads instrument parameters into a workspace. where these parameters are associated component names as defined in Instrument Definition File (IDF) or a string consisting of the contents of such.

See Also

SaveParameterFile

Properties

Name	Direction	Type	Default	Description
Workspace	InOut	MatrixWorkspace	Mandatory	The name of the workspace to load the instrument parameters into.
Filename	Input	string		The filename (including its full or relative path) of a parameter definition file. The file extension must either be .xml or .XML. Allowed extensions: [‘.xml’]
ParameterXML	Input	string		The parameter definition XML as a string.

Description

This algorithm allows instrument parameters to be specified in a separate file from the IDF. The required format for this file is identical to that used for defining parameters through <component-link> tags in an IDF. Below is an example of how to define a parameter named ‘test’ to be associated with a component named ‘bank_90degnew’ defined in the IDF of the HRPD instrument:

Components may also be identified by the id of a detector. The example below also demonstrates how to define a parameter named ‘test2’ for a component whose detector has an id of ‘14’.

<?xml version="1.0" encoding="UTF-8" ?>
<parameter-file instrument="HRPD" valid-from="YYYY-MM-DD HH:MM:SS">

<component-link name="bank_90degnew" >
  <parameter name="test"> <value val="50.0" /> </parameter>
</component-link>

<component-link id="14" >
  <parameter name="test2"> <value val="50.0" /> </parameter>
</component-link>

</parameter-file>

Categories: AlgorithmIndex | DataHandling\Instrument

Source

C++ header: LoadParameterFile.h

C++ source: LoadParameterFile.cpp