Skip to content

Commit

Permalink
ChangeLogTime documentation. Refs #9571
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreiSavici committed Jun 23, 2014
1 parent bf6cc8b commit 14930f4
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 1 deletion.
30 changes: 30 additions & 0 deletions Code/Mantid/docs/source/algorithms/ChangeLogTime-v1.rst
Expand Up @@ -9,6 +9,36 @@
Description
-----------

Adds a constant to the times for the requested log.

Usage
-----

.. testcode:: ChangeLogTime

#Load a workspace
w=Load('CNCS_7860')
#get the log times for a particular variable
original=w.getRun()['Speed5'].times
#Change the log times
w=ChangeLogTime(w,LogName='Speed5',TimeOffset='10')
#get the log times for a particular variable, after change
modified=w.getRun()['Speed5'].times
#print times
print "OriginalTimes: ", original
print "ModifiedTimes: ", modified


.. testcleanup:: ChangeLogTime

DeleteWorkspace('w')


Output:

.. testoutput:: ChangeLogTime

OriginalTimes: [2010-Mar-25 16:09:27.780000000,2010-Mar-25 16:10:01.560998229,2010-Mar-25 16:10:31.514001159,2010-Mar-25 16:11:25.498002319]
ModifiedTimes: [2010-Mar-25 16:09:37.780000000,2010-Mar-25 16:10:11.560998229,2010-Mar-25 16:10:41.514001159,2010-Mar-25 16:11:35.498002319]

.. categories::
Expand Up @@ -14,7 +14,7 @@ rings. This algorithm reads a workspace and an angle step, then
generates a grouping file (.xml) and a par file (.par), by grouping
detectors in intervals i\*step to (i+1)\*step. The par file is required
for saving in the NXSPE format, since Mantid does not correctly
calculates the correct angles for detector groups. It will contain
calculate the angles for detector groups. It will contain
average distances to the detector groups, and average scattering angles.
The x and y extents in the par file are radians(step)\*distance and
0.01, and are not supposed to be accurate.
Expand Down
1 change: 1 addition & 0 deletions Code/Mantid/docs/source/algorithms/MaskBTP-v1.rst
@@ -1,3 +1,4 @@

.. algorithm::

.. summary::
Expand Down

0 comments on commit 14930f4

Please sign in to comment.