From f1cac732df787d56e91763ace35b4fa66e730256 Mon Sep 17 00:00:00 2001 From: Arturs Bekasovs Date: Thu, 5 Jun 2014 16:18:51 +0100 Subject: [PATCH] Refs #9568. AlphaCalc --- .../docs/source/algorithms/AlphaCalc-v1.rst | 29 +++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/Code/Mantid/docs/source/algorithms/AlphaCalc-v1.rst b/Code/Mantid/docs/source/algorithms/AlphaCalc-v1.rst index f53230c482b9..af96da45815b 100644 --- a/Code/Mantid/docs/source/algorithms/AlphaCalc-v1.rst +++ b/Code/Mantid/docs/source/algorithms/AlphaCalc-v1.rst @@ -10,10 +10,35 @@ Description ----------- Returns the relative efficiency of the forward detector group compared -to the backward detector group. If Alpha is larger than 1 more counts +to the backward detector group. If ``Alpha`` is larger than 1 more counts has been collected in the forward group. This algorithm leave the input workspace unchanged. To group detectors -in a workspace use :ref:`algm-GroupDetectors`. +in a workspace use :ref:`algm-MuonGroupDetectors`. + +Usage +----- + +.. include:: ../usagedata-note.txt + +**Example - Calculating Alpha of a MUSR run:** + +.. testcode:: ExMUSRAlpha + + loaded = LoadMuonNexus('MUSR0015189.nxs', AutoGroup=True) + + first_period = loaded[0].getItem(0) + + alpha = AlphaCalc(first_period, + FirstGoodValue=0.55, + LastGoodValue=12.0) + + print 'Alpha value of the first period: {:.3f}'.format(alpha) + +Output: + +.. testoutput:: ExMUSRAlpha + + Alpha value of the first period: 1.339 .. categories::