From ee1ed6170521586e9fa2b31481ab818ce810a34c Mon Sep 17 00:00:00 2001
From: Samuel Jackson <samueljackson@outlook.com>
Date: Thu, 14 Sep 2017 08:51:47 +0100
Subject: [PATCH] Refs #20409 Update documentation
---
Framework/Crystal/src/FindSXPeaks.cpp | 9 ++---
docs/source/algorithms/FindSXPeaks-v1.rst | 44 ++++++++++++-----------
2 files changed, 28 insertions(+), 25 deletions(-)
diff --git a/Framework/Crystal/src/FindSXPeaks.cpp b/Framework/Crystal/src/FindSXPeaks.cpp
index 0d0e472af09..d2b21ac4e6c 100644
--- a/Framework/Crystal/src/FindSXPeaks.cpp
+++ b/Framework/Crystal/src/FindSXPeaks.cpp
@@ -58,13 +58,14 @@ void FindSXPeaks::init() {
declareProperty("RangeLower", EMPTY_DBL(),
"The X value to search from (default 0)");
declareProperty("RangeUpper", EMPTY_DBL(),
- "The X value to search to (default FindSXPeaks)");
+ "The X value to search to (default total number of bins)");
auto mustBePositive = boost::make_shared<BoundedValidator<int>>();
mustBePositive->setLower(0);
declareProperty("StartWorkspaceIndex", 0, mustBePositive,
- "Start spectrum number (default 0)");
- declareProperty("EndWorkspaceIndex", EMPTY_INT(), mustBePositive,
- "End spectrum number (default FindSXPeaks)");
+ "Start workspace index (default 0)");
+ declareProperty(
+ "EndWorkspaceIndex", EMPTY_INT(), mustBePositive,
+ "End workspace index (default to total number of histograms)");
// ---------------------------------------------------------------
// Peak strategies + Threshold
diff --git a/docs/source/algorithms/FindSXPeaks-v1.rst b/docs/source/algorithms/FindSXPeaks-v1.rst
index 6c381e0f144..501155d9bef 100644
--- a/docs/source/algorithms/FindSXPeaks-v1.rst
+++ b/docs/source/algorithms/FindSXPeaks-v1.rst
@@ -18,11 +18,12 @@ d-spacing.
Strongest peak mode:
- The highest intensity bin is taken to be the peak, so the algorithm only
- finds one peak per spectra - In this case the background is calculated as
- the average of the start and end intensity multiplied by the provided
+ finds one peak per spectra. In this case the background is calculated as the
+ average of the start and end intensity multiplied by the provided
SignalBackground parameter. Peaks that are not above the background are
- culled. - This peak finding mode is mainly used with the ResolutionStrategy
- set to RelativeResolution. In this case, the resolution parameter defines a
+ culled.
+- This peak finding mode is mainly used with the ResolutionStrategy set to
+ RelativeResolution. In this case, the resolution parameter defines a
tolerance which is compared to the absolute difference between the parameters
:math:`\phi`, :math:`2\theta`, and :math:`t` of two found peaks. If the
absolute difference between any of the parameters for two peaks is greater
@@ -35,23 +36,24 @@ Strongest peak mode:
All peaks mode:
- All peaks in each spectra above a certain threshold are detected as peaks
- (see below for the threshold). - In this case the user provides an
- absolute, global background/threshold value which is set with the
- AbsoluteBackground parameter. Peaks that are not above the absolute
- background are culled. A good way of identifying the background is to inspect
- your data set in pick mode within the InstrumentView. Ensure that your
- absolute background has been set high enough, else the algorithm will pick up
- noise as peaks. - This peak finding mode provides the best results when
- used with the ResolutionStrategy set to AbsoluteResolution, which allows the
- user to set absolute resolution values for the XUnitResolution (either in
- units of TOF or d-spacing), PhiResolution and the TwoThetaResolution
- parameters. These resolution parameters define tolerances which are compared
- to the absolute difference between the parameters :math:`\phi`,
- :math:`2\theta`, and :math:`t` of two found peaks. If the absolute
- difference between any of the parameters for two peaks is greater than the
- absolute tolerance then the two peaks are classed as not the same. i.e. if
- :math:`|\phi_1 - \phi_2| > PhiTolerance then peaks 1 & 2 are not the same (as
- well as similar definitions for :math:`2\theta` and :math:`t`).
+ (see below for the threshold).
+- In this case the user provides an absolute, global background/threshold
+ value which is set with the AbsoluteBackground parameter. Peaks that are not
+ above the absolute background are culled. A good way of identifying the
+ background is to inspect your data set in pick mode within the
+ InstrumentView. Ensure that your absolute background has been set high
+ enough, else the algorithm will pick up noise as peaks.
+- This peak finding mode provides the best results when used with the
+ ResolutionStrategy set to AbsoluteResolution, which allows the user to set
+ absolute resolution values for the XUnitResolution (either in units of TOF or
+ d-spacing), PhiResolution and the TwoThetaResolution parameters. These
+ resolution parameters define tolerances which are compared to the absolute
+ difference between the parameters :math:`\phi`, :math:`2\theta`, and
+ :math:`t` of two found peaks. If the absolute difference between any of the
+ parameters for two peaks is greater than the absolute tolerance then the two
+ peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| >
+ PhiTolerance then peaks 1 & 2 are not the same (as well as similar
+ definitions for :math:`2\theta` and :math:`t`).
General points:
--
GitLab