From 695fe4ecaee5952ea454ab01ac11fcbc830ff8b7 Mon Sep 17 00:00:00 2001
From: Shahroz Ahmed <shahroz.ahmed@stfc.ac.uk>
Date: Thu, 19 May 2016 11:11:10 +0100
Subject: [PATCH] Engineering_Diffraction documentation updated
refs #16194
---
.../EnggDiffractionViewQtGUI.cpp | 5 ++---
.../interfaces/Engineering_Diffraction.rst | 22 +++++++++++++------
2 files changed, 17 insertions(+), 10 deletions(-)
diff --git a/MantidQt/CustomInterfaces/src/EnggDiffraction/EnggDiffractionViewQtGUI.cpp b/MantidQt/CustomInterfaces/src/EnggDiffraction/EnggDiffractionViewQtGUI.cpp
index ec41ff8bc2c..14b1412d26e 100644
--- a/MantidQt/CustomInterfaces/src/EnggDiffraction/EnggDiffractionViewQtGUI.cpp
+++ b/MantidQt/CustomInterfaces/src/EnggDiffraction/EnggDiffractionViewQtGUI.cpp
@@ -260,7 +260,7 @@ void EnggDiffractionViewQtGUI::doSetupTabFitting() {
SLOT(clearPeakList()));
connect(m_uiTabFitting.pushButton_plot_separate_window, SIGNAL(released()),
- SLOT(plotSeparateWindow()));
+ SLOT(plotSeparateWindow()));
m_uiTabFitting.dataPlot->setCanvasBackground(Qt::white);
m_uiTabFitting.dataPlot->setAxisTitle(QwtPlot::xBottom, "d-Spacing (A)");
@@ -1643,8 +1643,7 @@ void MantidQt::CustomInterfaces::EnggDiffractionViewQtGUI::savePeakList() {
}
void MantidQt::CustomInterfaces::EnggDiffractionViewQtGUI::clearPeakList() {
- QString emptyStr = "";
- m_uiTabFitting.lineEdit_fitting_peaks->setText(emptyStr);
+ m_uiTabFitting.lineEdit_fitting_peaks->clear();
}
void EnggDiffractionViewQtGUI::instrumentChanged(int /*idx*/) {
diff --git a/docs/source/interfaces/Engineering_Diffraction.rst b/docs/source/interfaces/Engineering_Diffraction.rst
index 12e6bf8b241..a7183ed6add 100644
--- a/docs/source/interfaces/Engineering_Diffraction.rst
+++ b/docs/source/interfaces/Engineering_Diffraction.rst
@@ -330,9 +330,9 @@ Output
Once the Fit button has been clicked, wait until the Fitting process has
completed and upon completion you should be able to view on the Fitting
-tab plots the focused workspace in the background in black, whereas the
-expected peaks plotted in various colours over lapping the focused
-workspace peaks.
+tab; the focused workspace plotted in the background in grey crosses.
+Whereas the expected peaks plotted in various colours over lapping the
+focused workspace peaks.
Within the :ref:`Preview-Engineering_Diffraction-ref` section user is
able to zoom-in or zoom-out as well as select, add and save peaks.
@@ -353,7 +353,10 @@ Preview
^^^^^^^
Once the fitting process has completed and you are able to view a
focused workspace with listed expected peaks on the data plot, Select
-Peak button should should also be enabled.
+Peak button should should also be enabled. If the fitting fails with
+the given peaks then the focused workspace will still be plotted so
+that user can select peaks manually.
+
By clicking Select Peak button the peak picker tool can be activated.
To select a peak simply hold *Shift* key and left-click on the graph
near the peak's center.
@@ -366,9 +369,14 @@ the plot.
When user is satisfied with the center position of the peak, you may
add the selected peak to :ref:`ExpectedPeaks-Engineering_Diffraction-ref`
-list by clicking Add Peak button. User may rerun Fit process with
-the new selected peaks or save the peaks list as *CSV* file by clicking
-Save Peak List button.
+list by clicking Add Peak button. User may rerun Fit process by
+clearing peaks list using Clear button and manually selecting peaking
+using Select Peak button or instead Save the peaks list in *CSV* file
+by clicking Save button.
+
+User may plot single peak fitting workspace in separate window by using
+Plot To Separate Window button, if the *engggui_fitting_single_peaks*
+is available.
.. _setting-Engineering_Diffraction-ref:
--
GitLab