From 63fddc515dafc1e2229e1f8392412c074fc84f18 Mon Sep 17 00:00:00 2001 From: Owen Arnold Date: Thu, 19 Mar 2015 09:37:57 +0000 Subject: [PATCH] refs #11304. Add documentation --- .../docs/source/algorithms/CreateMD-v1.rst | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 Code/Mantid/docs/source/algorithms/CreateMD-v1.rst diff --git a/Code/Mantid/docs/source/algorithms/CreateMD-v1.rst b/Code/Mantid/docs/source/algorithms/CreateMD-v1.rst new file mode 100644 index 000000000000..107ebcacbe1d --- /dev/null +++ b/Code/Mantid/docs/source/algorithms/CreateMD-v1.rst @@ -0,0 +1,36 @@ +.. algorithm:: + +.. summary:: + +.. alias:: + +.. properties:: + +Description +----------- + +This workflow algorithm creates MDWorkspaces in the Q3D, HKL frame using `ConvertToMD `__. + +*u* and *v* are required. *u* and *v* are both 3-element vectors. These specify how the crystal's axes were oriented relative to the spectrometer in the setup for which you define psi to be zero. *u* specifies the lattice vector that is parallel to the incident neutron beam, whilst *v* is a vector perpendicular to this in the horizontal plane. In UB matrix notation, *u* and *v* provide the U matrix. See `SetUB `__. *Alatt* and *Angdeg* are the lattice parameters in Angstroms and lattice angles in degrees respectively. Both are 3-element vectors. These form the B-matrix. + +If goniometer settings have been provided then these will be applied to the input workspace(s). For multiple input workspaces, you will need to provide goniometer settings (*Psi*, *Gl*, *Gs*) as vectors where each element of the vector corresponds to the workspace in the order listed in *InputWorkspaces*. You do not need to provide the goniometer settings at all. If you run `SetGoniometer `__ individually on the input workspace prior to running CreateMD, then those settings will not be overwritten by CreateMD. + +If a sequence of input workspaces are provided then these are individually processed as above, and are merged together via `MergeMD `__. Intermediate workspaces are not kept. + + +*Example* +########################################## + +.. testcode:: CreateMDExample + + print 'Hello World' + +Output +^^^^^^ + +.. testoutput:: CreateMDExample + + 'Not implemented yet' + + +.. categories::