Skip to content

Commit

Permalink
Fix CalculatResolution regression and update docs.
Browse files Browse the repository at this point in the history
Refs #10198.
  • Loading branch information
Harry Jeffery committed Sep 2, 2014
1 parent 17627f8 commit 50e193e
Showing 1 changed file with 8 additions and 1 deletion.
Expand Up @@ -14,17 +14,24 @@ the reflectometry resolution (dq/q) from them. If no value is provided for two t
then CalculateResolution will attempt to fetch a value from the workspace's log
using the two theta log name provided.

CalculateResolution outputs two values, the calculated resolution and the value of
TwoTheta that was used in the calculation. The latter is useful when TwoTheta was not
given to CalculateResolution, causing CalculateResolution to extract it from the
workspace's sample log.

Usage
-----

.. testcode::

ws = Load('INTER00013460')
res = CalculateResolution(Workspace = ws, TwoTheta = 0.7)
res, two_theta = CalculateResolution(Workspace = ws, TwoTheta = 0.7)
print("Resolution: %.4f" % res)
print("Two Theta: %.4f" % two_theta)

.. testoutput::

Resolution: 0.0340
Two Theta: 0.7000

.. categories::

0 comments on commit 50e193e

Please sign in to comment.