Skip to content

Commit

Permalink
Refs #9568. AlphaCalc
Browse files Browse the repository at this point in the history
  • Loading branch information
arturbekasov committed Jun 6, 2014
1 parent 3e697d7 commit f1cac73
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions Code/Mantid/docs/source/algorithms/AlphaCalc-v1.rst
Expand Up @@ -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::

0 comments on commit f1cac73

Please sign in to comment.