From 642da70b3c1f6f65e47e8334d63fbd52ab407459 Mon Sep 17 00:00:00 2001 From: Dan Nixon Date: Mon, 29 Sep 2014 10:39:19 +0100 Subject: [PATCH] Added documentation to MSGDiffractionReduction Refs #10215 --- .../algorithms/MSGDiffractionReduction-v1.rst | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 Code/Mantid/docs/source/algorithms/MSGDiffractionReduction-v1.rst diff --git a/Code/Mantid/docs/source/algorithms/MSGDiffractionReduction-v1.rst b/Code/Mantid/docs/source/algorithms/MSGDiffractionReduction-v1.rst new file mode 100644 index 000000000000..58a94f2b8559 --- /dev/null +++ b/Code/Mantid/docs/source/algorithms/MSGDiffractionReduction-v1.rst @@ -0,0 +1,41 @@ +.. algorithm:: + +.. summary:: + +.. alias:: + +.. properties:: + +Description +----------- + +The generic routing used to reduce diffraction runs from indirect inelastic geometry instruments at ISIS. + +Usage +----- + +**Example - Running MSGDiffractionReduction.** + +.. testcode:: ExMSGDiffractionReductionSimple + + MSGDiffractionReduction(InputFiles='IRS21360.raw', + OutputWorkspaceGroup='DiffOut', + Instrument='IRIS', + Mode='diffspec', + DetectorRange=[105,112]) + + ws = mtd['DiffOut'].getItem(0) + + print 'Workspace name: %s' % ws.getName() + print 'Number of spectra: %d' % ws.getNumberHistograms() + print 'Number of bins: %s' % ws.blocksize() + +Output: + +.. testoutput:: ExMSGDiffractionReductionSimple + + Workspace name: irs21360_diffspec_red + Number of spectra: 1 + Number of bins: 1935 + +.. categories::