MoveInstrumentComponent

From MantidProject

Jump to: navigation, search

Summary

Moves an instrument component to a new position.

Properties

Order Name Direction Type Default Description
1 Workspace InOut Workspace2D Mandatory The name of the workspace for which the new instrument configuration will have an effect. Any other workspaces stored in the analysis data service will be unaffected.
2 ComponentName Input string Optional The name of the component to move. Component names are defined in the instrument definition files.
3 DetectorID Input integer Optional The ID of the detector to move. If both the component name and the detector ID are set the latter will be used.
4 X Input double Optional The x-part of the new location vector.
5 Y Input double Optional The y-part of the new location vector.
6 Z Input double Optional The z-part of the new location vector.
7 RelativePosition Input bool true The property defining how the (X,Y,Z) vector should be interpreted. If true it is a vector relative to the initial component's position. Otherwise it is a new position in the absolute co-ordinates.

Source Code

Header MoveInstrumentComponent.h

Source MoveInstrumentComponent.cpp

Personal tools
Create a book