Skip to content

Commit

Permalink
AverageLogData documentation. refs #9571
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreiSavici committed Jun 25, 2014
1 parent e8d778b commit 74c5bc8
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions Code/Mantid/docs/source/algorithms/AverageLogData-v1.rst
Expand Up @@ -18,4 +18,31 @@ and standard deviations are NANs. If all the proton pulses occur after
the last value, and FixZero is false, the average is equal to the last
value, and the standard deviation is zero.

Usage
-----

.. include:: ../usagedata-note.txt

.. testcode:: AverageLogData

#load a workspace with logs
ws=Load("CNCS_7860")

#apply algorithm
value,error=AverageLogData(ws,LogName="ChopperStatus5")

#print the values
print "ChopperStatus5 : %1.3f +/- %1.3f"%(value,error)


.. testcleanup:: AverageLogData

DeleteWorkspace('ws')

Output:

.. testoutput:: AverageLogData

ChopperStatus5 : 3.942 +/- 0.309

.. categories::

0 comments on commit 74c5bc8

Please sign in to comment.