From e4cbdefc628ddd4151f5e06cde7c484f57218bc0 Mon Sep 17 00:00:00 2001
From: Roman Tolchenov <roman.tolchenov@stfc.ac.uk>
Date: Tue, 10 Jun 2014 14:20:10 +0100
Subject: [PATCH] Re #9579. Usage example for GetDetectorOffsets.
---
.../Algorithms/src/GetDetectorOffsets.cpp | 3 +-
.../algorithms/GetDetectorOffsets-v1.rst | 53 +++++++++++++++++--
2 files changed, 52 insertions(+), 4 deletions(-)
diff --git a/Code/Mantid/Framework/Algorithms/src/GetDetectorOffsets.cpp b/Code/Mantid/Framework/Algorithms/src/GetDetectorOffsets.cpp
index c43525ee414..c135e05a3aa 100644
--- a/Code/Mantid/Framework/Algorithms/src/GetDetectorOffsets.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/GetDetectorOffsets.cpp
@@ -64,7 +64,8 @@ namespace Mantid
declareProperty(new WorkspaceProperty<>("MaskWorkspace","Mask",Direction::Output),
"An output workspace containing the mask.");
// Only keep peaks
- declareProperty("PeakFunction", "Gaussian", boost::make_shared<StringListValidator>(FunctionFactory::Instance().getFunctionNames<IPeakFunction>()));
+ declareProperty("PeakFunction", "Gaussian", boost::make_shared<StringListValidator>(FunctionFactory::Instance().getFunctionNames<IPeakFunction>()),
+ "The function type for fitting the peaks.");
declareProperty("MaxOffset", 1.0, "Maximum absolute value of offsets; default is 1");
}
diff --git a/Code/Mantid/docs/source/algorithms/GetDetectorOffsets-v1.rst b/Code/Mantid/docs/source/algorithms/GetDetectorOffsets-v1.rst
index 33536347d52..cbb2b522fc1 100644
--- a/Code/Mantid/docs/source/algorithms/GetDetectorOffsets-v1.rst
+++ b/Code/Mantid/docs/source/algorithms/GetDetectorOffsets-v1.rst
@@ -16,18 +16,65 @@ reference spectrum and all of the other spectrum are cross correlated
against it. Each output spectrum then contains a peak whose location
defines the offset from the reference spectrum.
-The algorithm iterates over each spectrum in the workspace and fits a
-`Gaussian <Gaussian>`__ function to the reference peaks. The fit is used
+The algorithm iterates over each spectrum in the workspace and fits a PeakFunction (default is a
+`Gaussian <http://www.mantidproject.org/Gaussian>`__ function) to the reference peaks. The fit is used
to calculate the centre of the fitted peak, and the offset is then
calculated as:
:math:`-peakCentre*step/(dreference+PeakCentre*step)`
-This is then written into a `.cal file <CalFile>`__ for every detector
+This is then written into a `.cal file <http://www.mantidproject.org/CalFile>`__ for every detector
that contributes to that spectrum. All of the entries in the cal file
are initially set to both be included, but also to all group into a
single group on :ref:`algm-DiffractionFocussing`. The
:ref:`algm-CreateCalFileByNames` algorithm can be used to
alter the grouping in the cal file.
+Usage
+-----
+
+.. testcode::
+
+ import os
+
+ # Create a workspace with a Gaussian peak in the centre.
+ ws = CreateSampleWorkspace(Function='User Defined',UserDefinedFunction='name=Gaussian,Height=1,PeakCentre=10,Sigma=1',XMin=0,XMax=20,BinWidth=0.1)
+ ws.getAxis(0).setUnit( 'dSpacing' )
+
+ # Generate a file path to save the .cal file at.
+ calFilePath = os.path.expanduser( '~/MantidUsageExample_CalFile.cal' )
+
+ # Run the algorithm
+ msk = GetDetectorOffsets(ws,0.001,10.0,0, 10, calFilePath)
+
+ # Read the saved .cal file back in
+ f = open( calFilePath, 'r' )
+ file = f.read().split('\n')
+ f.close()
+
+ # Print out first 10 lines of the file
+ print file[0][:55],'...'
+ for line in file[1:10]:
+ print line
+
+Output
+######
+
+.. testoutput::
+
+ # Calibration file for instrument basic_rect written on ...
+ # Format: number UDET offset select group
+ 0 100 -0.0014265 1 1
+ 1 101 -0.0014265 1 1
+ 2 102 -0.0014265 1 1
+ 3 103 -0.0014265 1 1
+ 4 104 -0.0014265 1 1
+ 5 105 -0.0014265 1 1
+ 6 106 -0.0014265 1 1
+ 7 107 -0.0014265 1 1
+
+.. testcleanup::
+
+ os.remove( calFilePath )
+
.. categories::
--
GitLab