diff --git a/Framework/Algorithms/CMakeLists.txt b/Framework/Algorithms/CMakeLists.txt
index c2a6986310f1b84dee525af5a5a59d25911b9337..c5c0b300c65b37ab071ad400a391838d0e15e686 100644
--- a/Framework/Algorithms/CMakeLists.txt
+++ b/Framework/Algorithms/CMakeLists.txt
@@ -1032,8 +1032,11 @@ set(TEST_FILES
WorkspaceGroupTest.h)
set(TEST_PY_FILES
- NormaliseToUnityTest.py
- ReflectometryBackgroundSubtractionTest.py)
+ test/NormaliseToUnityTest.py
+ test/ReflectometryBackgroundSubtractionTest.py
+ test/ReflectometryReductionOne2Test.py)
+
+ pyunittest_add_test(${CMAKE_CURRENT_SOURCE_DIR} python ${TEST_PY_FILES})
if(COVERALLS)
foreach(loop_var ${SRC_FILES} ${C_SRC_FILES} ${INC_FILES})
diff --git a/Framework/Algorithms/inc/MantidAlgorithms/CreateTransmissionWorkspace2.h b/Framework/Algorithms/inc/MantidAlgorithms/CreateTransmissionWorkspace2.h
index c481de52568a284d3c3e5c827806d8199c97bd38..221094226e277cfc1ed670fab1f097fbf3de7fc2 100644
--- a/Framework/Algorithms/inc/MantidAlgorithms/CreateTransmissionWorkspace2.h
+++ b/Framework/Algorithms/inc/MantidAlgorithms/CreateTransmissionWorkspace2.h
@@ -42,9 +42,9 @@ private:
/// Get the run number of a given workspace
std::string getRunNumber(std::string const &propertyName);
/// Store a transition run in ADS
- void storeTransitionRun(int which, API::MatrixWorkspace_sptr ws);
+ void setOutputTransmissionRun(int which, API::MatrixWorkspace_sptr ws);
/// Store the stitched transition workspace run in ADS
- void storeOutputWorkspace(API::MatrixWorkspace_sptr ws);
+ void setOutputWorkspace(API::MatrixWorkspace_sptr ws);
/// Run numbers for the first/second transmission run
std::string m_firstTransmissionRunNumber;
diff --git a/Framework/Algorithms/inc/MantidAlgorithms/ReflectometryReductionOne2.h b/Framework/Algorithms/inc/MantidAlgorithms/ReflectometryReductionOne2.h
index 12959e262a19559a1ea5ddf070996d9f4b4ddac6..cc642cef5db02401f3c30b2d1c5cb0ffe95712c8 100644
--- a/Framework/Algorithms/inc/MantidAlgorithms/ReflectometryReductionOne2.h
+++ b/Framework/Algorithms/inc/MantidAlgorithms/ReflectometryReductionOne2.h
@@ -68,6 +68,9 @@ private:
Mantid::API::MatrixWorkspace_sptr
transOrAlgCorrection(Mantid::API::MatrixWorkspace_sptr detectorWS,
const bool detectorWSReduced);
+ // Performs background subtraction
+ Mantid::API::MatrixWorkspace_sptr
+ backgroundSubtraction(Mantid::API::MatrixWorkspace_sptr detectorWS);
// Performs transmission corrections
Mantid::API::MatrixWorkspace_sptr
transmissionCorrection(Mantid::API::MatrixWorkspace_sptr detectorWS,
diff --git a/Framework/Algorithms/inc/MantidAlgorithms/ReflectometryWorkflowBase2.h b/Framework/Algorithms/inc/MantidAlgorithms/ReflectometryWorkflowBase2.h
index db477696fabddb1ee0c6027bb9537aee657517c1..0e282a691a6e354a2e93a276a7d8936583596039 100644
--- a/Framework/Algorithms/inc/MantidAlgorithms/ReflectometryWorkflowBase2.h
+++ b/Framework/Algorithms/inc/MantidAlgorithms/ReflectometryWorkflowBase2.h
@@ -29,8 +29,11 @@ protected:
void initMonitorProperties();
/// Initialize direct beam properties
void initDirectBeamProperties();
+ /// Initialize background subtraction properties
+ void initBackgroundProperties();
/// Initialize transmission properties
void initTransmissionProperties();
+ void initTransmissionOutputProperties();
/// Initialize properties for stitching transmission runs
void initStitchProperties();
/// Initialize corection algorithm properties
@@ -39,6 +42,8 @@ protected:
void initMomentumTransferProperties();
/// Initialize properties for diagnostics
void initDebugProperties();
+ /// Validate background-type properties
+ std::map<std::string, std::string> validateBackgroundProperties() const;
/// Validate reduction-type properties
std::map<std::string, std::string> validateReductionProperties() const;
/// Validate direct beam properties
@@ -58,7 +63,7 @@ protected:
// Create a detector workspace from input workspace in wavelength
Mantid::API::MatrixWorkspace_sptr
makeDetectorWS(Mantid::API::MatrixWorkspace_sptr inputWS,
- const bool convert = true);
+ const bool convert = true, const bool sum = true);
// Create a monitor workspace from input workspace in wavelength
Mantid::API::MatrixWorkspace_sptr
makeMonitorWS(Mantid::API::MatrixWorkspace_sptr inputWS,
@@ -93,17 +98,12 @@ protected:
std::string
convertToSpectrumNumber(const std::string &workspaceIndex,
Mantid::API::MatrixWorkspace_const_sptr ws) const;
-
- std::string convertProcessingInstructionsToWorkspaceIndices(
- const std::string &instructions,
- Mantid::API::MatrixWorkspace_const_sptr ws) const;
-
- std::string convertToWorkspaceIndex(const std::string &spectrumNumber,
- MatrixWorkspace_const_sptr ws) const;
-
std::string convertProcessingInstructionsToSpectrumNumbers(
const std::string &instructions,
Mantid::API::MatrixWorkspace_const_sptr ws) const;
+
+ void setWorkspacePropertyFromChild(Algorithm_sptr alg,
+ std::string const &propertyName);
};
} // namespace Algorithms
} // namespace Mantid
diff --git a/Framework/Algorithms/src/ApplyCalibration.cpp b/Framework/Algorithms/src/ApplyCalibration.cpp
index 380a3379292c0a384869cb565b7d8ca092e55ec2..0f4581ec65a6e9e14045f4460ac10cc215002f1f 100644
--- a/Framework/Algorithms/src/ApplyCalibration.cpp
+++ b/Framework/Algorithms/src/ApplyCalibration.cpp
@@ -7,11 +7,18 @@
#include "MantidAlgorithms/ApplyCalibration.h"
#include "MantidAPI/ITableWorkspace.h"
#include "MantidAPI/MatrixWorkspace.h"
+#include "MantidGeometry/Instrument/ComponentInfo.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
+#include "MantidGeometry/Objects/IObject.h"
+#include "MantidKernel/Logger.h"
namespace Mantid {
namespace Algorithms {
+namespace {
+Kernel::Logger logger("ApplyCalibration");
+}
+
DECLARE_ALGORITHM(ApplyCalibration)
using namespace Kernel;
@@ -27,9 +34,14 @@ void ApplyCalibration::init() {
declareProperty(
std::make_unique<API::WorkspaceProperty<API::ITableWorkspace>>(
- "PositionTable", "", Direction::Input),
+ "CalibrationTable", "", Direction::Input, PropertyMode::Optional),
"The name of the table workspace containing the new "
"positions of detectors");
+
+ declareProperty(
+ std::make_unique<API::WorkspaceProperty<API::ITableWorkspace>>(
+ "PositionTable", "", Direction::Input, PropertyMode::Optional),
+ "Deprecated: Use Property 'CalibrationTable'");
}
/** Executes the algorithm. Moving detectors of input workspace to positions
@@ -41,17 +53,90 @@ void ApplyCalibration::init() {
void ApplyCalibration::exec() {
// Get pointers to the workspace, parameter map and table
API::MatrixWorkspace_sptr inputWS = getProperty("Workspace");
+ API::ITableWorkspace_sptr CalTable = getProperty("CalibrationTable");
API::ITableWorkspace_sptr PosTable = getProperty("PositionTable");
- size_t numDetector = PosTable->rowCount();
- ColumnVector<int> detID = PosTable->getVector("Detector ID");
- ColumnVector<V3D> detPos = PosTable->getVector("Detector Position");
- // numDetector needs to be got as the number of rows in the table and the
- // detID got from the (i)th row of table.
- auto &detectorInfo = inputWS->mutableDetectorInfo();
- for (size_t i = 0; i < numDetector; ++i) {
- const auto index = detectorInfo.indexOf(detID[i]);
- detectorInfo.setPosition(index, detPos[i]);
+ // Elucidate if using property PositionTable table instead of CalibrationTable
+ if (!CalTable && !PosTable) {
+ throw std::runtime_error(
+ "Either CalibrationTable or PositionTable must be supplied");
+ }
+ if (PosTable && !CalTable) {
+ logger.notice("Property 'PositionTable' has been deprecated. Please use "
+ "'CalibrationTable' in its place\n");
+ CalTable = PosTable;
+ }
+
+ // initialize variables common to all calibrations
+ std::vector<std::string> columnNames = CalTable->getColumnNames();
+ size_t numDetector = CalTable->rowCount();
+ ColumnVector<int> detectorID = CalTable->getVector("Detector ID");
+
+ // Default calibration
+ if (std::find(columnNames.begin(), columnNames.end(), "Detector Position") !=
+ columnNames.end()) {
+ auto &detectorInfo = inputWS->mutableDetectorInfo();
+ ColumnVector<V3D> detPos = CalTable->getVector("Detector Position");
+ // PARALLEL_FOR_NO_WSP_CHECK()
+ for (size_t i = 0; i < numDetector; ++i) {
+ const auto index = detectorInfo.indexOf(detectorID[i]);
+ detectorInfo.setPosition(index, detPos[i]);
+ }
+ }
+
+ // Bar scan calibration: pixel Y-coordinate
+ if (std::find(columnNames.begin(), columnNames.end(),
+ "Detector Y Coordinate") != columnNames.end()) {
+ // the detectorInfo index of a particular pixel detector is the same as the
+ // componentInfo index for the same pixel detector
+ auto &detectorInfo = inputWS->mutableDetectorInfo();
+ ColumnVector<double> yCoordinate =
+ CalTable->getVector("Detector Y Coordinate");
+ // PARALLEL_FOR_NO_WSP_CHECK()
+ for (size_t i = 0; i < numDetector; ++i) {
+ const auto index = detectorInfo.indexOf(detectorID[i]);
+ V3D xyz = detectorInfo.position(index);
+ detectorInfo.setPosition(index, V3D(xyz.X(), yCoordinate[i], xyz.Z()));
+ }
+ }
+
+ // Apparent tube width calibration along X-coordinate
+ if (std::find(columnNames.begin(), columnNames.end(), "Detector Width") !=
+ columnNames.end()) {
+ auto &detectorInfo = inputWS->detectorInfo();
+ auto &componentInfo = inputWS->mutableComponentInfo();
+ ColumnVector<double> widths = CalTable->getVector("Detector Width");
+ // PARALLEL_FOR_NO_WSP_CHECK()
+ for (size_t i = 0; i < numDetector; ++i) {
+ const auto index = detectorInfo.indexOf(detectorID[i]);
+ double nominalWidth =
+ componentInfo.shape(index).getBoundingBox().width().X();
+ V3D oldScaleFactor = componentInfo.scaleFactor(index);
+ componentInfo.setScaleFactor(index,
+ V3D(widths[i] / nominalWidth,
+ oldScaleFactor.Y(), oldScaleFactor.Z()));
+ }
+ }
+
+ // Bar scan calibration: pixel height
+ if (std::find(columnNames.begin(), columnNames.end(), "Detector Height") !=
+ columnNames.end()) {
+ // the detectorInfo index of a particular pixel detector is the same as the
+ // componentInfo index for the same pixel detector
+ auto &detectorInfo = inputWS->mutableDetectorInfo();
+ auto &componentInfo = inputWS->mutableComponentInfo();
+ ColumnVector<double> height = CalTable->getVector("Detector Height");
+ // PARALLEL_FOR_NO_WSP_CHECK()
+ for (size_t i = 0; i < numDetector; ++i) {
+ const auto index = detectorInfo.indexOf(detectorID[i]);
+ // update pixel height along Y coordinate
+ double nominalHeight =
+ componentInfo.shape(index).getBoundingBox().width().Y();
+ V3D oldScaleFactor = componentInfo.scaleFactor(index);
+ componentInfo.setScaleFactor(index, V3D(oldScaleFactor.X(),
+ height[i] / nominalHeight,
+ oldScaleFactor.Z()));
+ }
}
}
diff --git a/Framework/Algorithms/src/CreateTransmissionWorkspace.cpp b/Framework/Algorithms/src/CreateTransmissionWorkspace.cpp
index b0149d84fb91747fd021317c8f9ec63a42589143..a5f07e0fbb77fe8c6c36f0d62590457fed3579ba 100644
--- a/Framework/Algorithms/src/CreateTransmissionWorkspace.cpp
+++ b/Framework/Algorithms/src/CreateTransmissionWorkspace.cpp
@@ -45,7 +45,7 @@ void CreateTransmissionWorkspace::init() {
declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
"FirstTransmissionRun", "", Direction::Input,
PropertyMode::Mandatory, inputValidator->clone()),
- "First transmission run, or the low wavelength transmision "
+ "First transmission run, or the low wavelength transmission "
"run if SecondTransmissionRun is also provided.");
declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
diff --git a/Framework/Algorithms/src/CreateTransmissionWorkspace2.cpp b/Framework/Algorithms/src/CreateTransmissionWorkspace2.cpp
index 7ca4e40e20707511be8f336dc8d6a5d1e562c103..a6afaed45819d50804ddd683cd0415e02d8c284e 100644
--- a/Framework/Algorithms/src/CreateTransmissionWorkspace2.cpp
+++ b/Framework/Algorithms/src/CreateTransmissionWorkspace2.cpp
@@ -9,6 +9,7 @@
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/Run.h"
#include "MantidAPI/WorkspaceUnitValidator.h"
+#include "MantidKernel/EnabledWhenProperty.h"
#include "MantidKernel/MandatoryValidator.h"
using namespace Mantid::API;
@@ -56,7 +57,7 @@ void CreateTransmissionWorkspace2::init() {
"FirstTransmissionRun", "", Direction::Input,
PropertyMode::Mandatory, inputValidator->clone()),
"First transmission run. Corresponds to the low wavelength "
- "transmision run if a SecondTransmissionRun is also "
+ "transmission run if a SecondTransmissionRun is also "
"provided.");
declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
@@ -96,6 +97,24 @@ void CreateTransmissionWorkspace2::init() {
std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
"OutputWorkspace", "", Direction::Output, PropertyMode::Optional),
"Output workspace in wavelength.");
+
+ // Declare Debug output workspaces
+
+ declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
+ "OutputWorkspaceFirstTransmission", "", Direction::Output,
+ PropertyMode::Optional),
+ "Output workspace in wavelength for first transmission run");
+ setPropertySettings(
+ "OutputWorkspaceFirstTransmission",
+ std::make_unique<Kernel::EnabledWhenProperty>("Debug", IS_EQUAL_TO, "1"));
+
+ declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
+ "OutputWorkspaceSecondTransmission", "",
+ Direction::Output, PropertyMode::Optional),
+ "Output workspace in wavelength for second transmission run");
+ setPropertySettings(
+ "OutputWorkspaceSecondTransmission",
+ std::make_unique<Kernel::EnabledWhenProperty>("Debug", IS_EQUAL_TO, "1"));
}
/** Validate inputs
@@ -121,40 +140,41 @@ CreateTransmissionWorkspace2::validateInputs() {
void CreateTransmissionWorkspace2::exec() {
getRunNumbers();
- MatrixWorkspace_sptr outWS;
-
+ // Process the first run
MatrixWorkspace_sptr firstTransWS = getProperty("FirstTransmissionRun");
convertProcessingInstructions(firstTransWS);
-
firstTransWS = normalizeDetectorsByMonitors(firstTransWS);
firstTransWS = cropWavelength(firstTransWS);
- MatrixWorkspace_sptr secondTransWS = getProperty("SecondTransmissionRun");
- if (secondTransWS) {
- storeTransitionRun(1, firstTransWS);
-
- convertProcessingInstructions(secondTransWS);
-
- secondTransWS = normalizeDetectorsByMonitors(secondTransWS);
- secondTransWS = cropWavelength(secondTransWS);
- storeTransitionRun(2, secondTransWS);
-
- // Stitch the results.
- auto stitch = createChildAlgorithm("Stitch1D");
- stitch->initialize();
- stitch->setProperty("LHSWorkspace", firstTransWS);
- stitch->setProperty("RHSWorkspace", secondTransWS);
- stitch->setPropertyValue("StartOverlap", getPropertyValue("StartOverlap"));
- stitch->setPropertyValue("EndOverlap", getPropertyValue("EndOverlap"));
- stitch->setPropertyValue("Params", getPropertyValue("Params"));
- stitch->setProperty("ScaleRHSWorkspace",
- getPropertyValue("ScaleRHSWorkspace"));
- stitch->execute();
- outWS = stitch->getProperty("OutputWorkspace");
- } else {
- outWS = firstTransWS;
+ // If we only have one run, set it as the output and finish
+ if (isDefault("SecondTransmissionRun")) {
+ setOutputWorkspace(firstTransWS);
+ return;
}
- storeOutputWorkspace(outWS);
+
+ // Process the second run
+ MatrixWorkspace_sptr secondTransWS = getProperty("SecondTransmissionRun");
+ convertProcessingInstructions(secondTransWS);
+ secondTransWS = normalizeDetectorsByMonitors(secondTransWS);
+ secondTransWS = cropWavelength(secondTransWS);
+
+ // Stitch the processed runs
+ auto stitch = createChildAlgorithm("Stitch1D");
+ stitch->initialize();
+ stitch->setProperty("LHSWorkspace", firstTransWS);
+ stitch->setProperty("RHSWorkspace", secondTransWS);
+ stitch->setPropertyValue("StartOverlap", getPropertyValue("StartOverlap"));
+ stitch->setPropertyValue("EndOverlap", getPropertyValue("EndOverlap"));
+ stitch->setPropertyValue("Params", getPropertyValue("Params"));
+ stitch->setProperty("ScaleRHSWorkspace",
+ getPropertyValue("ScaleRHSWorkspace"));
+ stitch->execute();
+ MatrixWorkspace_sptr stitchedWS = stitch->getProperty("OutputWorkspace");
+
+ // Set the outputs
+ setOutputWorkspace(stitchedWS);
+ setOutputTransmissionRun(1, firstTransWS);
+ setOutputTransmissionRun(2, secondTransWS);
}
/** Normalize detectors by monitors
@@ -222,12 +242,14 @@ CreateTransmissionWorkspace2::getRunNumber(std::string const &propertyName) {
return runNumber;
}
-/** Store a transition run in ADS
+/** Output an interim transmission run if in debug mode or if running as a
+ * child algorithm. Note that the workspace will only be output if a sensible
+ * name can be constructed, which requires the workspace to have a run number.
* @param which Which of the runs to store: 1 - first, 2 - second.
* @param ws A workspace to store.
*/
-void CreateTransmissionWorkspace2::storeTransitionRun(int which,
- MatrixWorkspace_sptr ws) {
+void CreateTransmissionWorkspace2::setOutputTransmissionRun(
+ int which, MatrixWorkspace_sptr ws) {
bool const isDebug = getProperty("Debug");
if (!isDebug)
return;
@@ -235,36 +257,71 @@ void CreateTransmissionWorkspace2::storeTransitionRun(int which,
if (which < 1 || which > 2) {
throw std::logic_error("There are only two runs: 1 and 2.");
}
+
+ // Set the output property
+ auto const runDescription =
+ which == 1 ? "FirstTransmission" : "SecondTransmission";
+ auto const propertyName = std::string("OutputWorkspace") + runDescription;
+
+ // If the user provided an output name, just set the value
+ if (!isDefault(propertyName)) {
+ setProperty(propertyName, ws);
+ return;
+ }
+
+ // Otherwise try to set a default name based on the run number
auto const &runNumber =
which == 1 ? m_firstTransmissionRunNumber : m_secondTransmissionRunNumber;
-
- if (!runNumber.empty()) {
- auto const name = TRANS_LAM_PREFIX + runNumber;
- AnalysisDataService::Instance().addOrReplace(name, ws);
+ if (runNumber.empty()) {
+ throw std::runtime_error(
+ std::string("Input workspace has no run number; cannot set default "
+ "name for the "
+ "output workspace. Please specify a name using the ") +
+ propertyName + std::string(" property."));
}
+
+ auto const defaultName = TRANS_LAM_PREFIX + runNumber;
+ setPropertyValue(propertyName, defaultName);
+ setProperty(propertyName, ws);
}
-/** Store the stitched transition workspace run in ADS
+/** Output the final transmission workspace
* @param ws A workspace to store.
+ * @throws If the output workspace does not have a name and a default could not
+ * be found
*/
-void CreateTransmissionWorkspace2::storeOutputWorkspace(
+void CreateTransmissionWorkspace2::setOutputWorkspace(
API::MatrixWorkspace_sptr ws) {
- // If the output name is not set, attempt to set a sensible
- // default based on the run number. If a required run number
- // is missing, then there's not much we can do so leave it empty.
- if (isDefault("OutputWorkspace") && !m_missingRunNumber) {
- std::string name = TRANS_LAM_PREFIX;
- if (!m_firstTransmissionRunNumber.empty()) {
- name.append(m_firstTransmissionRunNumber);
- }
- if (!m_secondTransmissionRunNumber.empty()) {
- name.append("_");
- name.append(m_secondTransmissionRunNumber);
+ // If the user provided an output name, just set the value
+ if (!isDefault("OutputWorkspace")) {
+ setProperty("OutputWorkspace", ws);
+ return;
+ }
+
+ // Otherwise, we want to set a default name based on the run number
+ if (m_missingRunNumber) {
+ if (isChild()) {
+ setProperty("OutputWorkspace", ws);
+ return;
+ } else {
+ throw std::runtime_error(
+ "Input workspace has no run number; cannot set default name for the "
+ "output workspace. Please specify a name using the OutputWorkspace "
+ "property.");
}
- setPropertyValue("OutputWorkspace", name);
}
+
+ std::string outputName = TRANS_LAM_PREFIX;
+ if (!m_firstTransmissionRunNumber.empty()) {
+ outputName.append(m_firstTransmissionRunNumber);
+ }
+ if (!m_secondTransmissionRunNumber.empty()) {
+ outputName.append("_");
+ outputName.append(m_secondTransmissionRunNumber);
+ }
+
+ setPropertyValue("OutputWorkspace", outputName);
setProperty("OutputWorkspace", ws);
}
-
} // namespace Algorithms
} // namespace Mantid
diff --git a/Framework/Algorithms/src/ReflectometryBackgroundSubtraction.cpp b/Framework/Algorithms/src/ReflectometryBackgroundSubtraction.cpp
index 11857f0183c1d0b38555963235fe636ae875b3b1..a28347a70e774e989bdb9b80c374e53fd641d5c3 100644
--- a/Framework/Algorithms/src/ReflectometryBackgroundSubtraction.cpp
+++ b/Framework/Algorithms/src/ReflectometryBackgroundSubtraction.cpp
@@ -179,7 +179,6 @@ void ReflectometryBackgroundSubtraction::calculatePixelBackground(
// will need to change if ISIS reflectometry get a 2D detector
LRBgd->setProperty("LowResolutionRange", "0,0");
LRBgd->setProperty("TypeOfDetector", "LinearDetector");
- LRBgd->setProperty("OutputWorkspace", getPropertyValue("OutputWorkspace"));
LRBgd->execute();
Workspace_sptr outputWS = LRBgd->getProperty("OutputWorkspace");
diff --git a/Framework/Algorithms/src/ReflectometryReductionOne2.cpp b/Framework/Algorithms/src/ReflectometryReductionOne2.cpp
index 76bc02295fd523fc6b018db139baa8937fd55699..f13d5438c333a847784374236eedb076d556c609 100644
--- a/Framework/Algorithms/src/ReflectometryReductionOne2.cpp
+++ b/Framework/Algorithms/src/ReflectometryReductionOne2.cpp
@@ -17,6 +17,7 @@
#include "MantidGeometry/Objects/BoundingBox.h"
#include "MantidHistogramData/LinearGenerator.h"
#include "MantidIndexing/IndexInfo.h"
+#include "MantidKernel/EnabledWhenProperty.h"
#include "MantidKernel/MandatoryValidator.h"
#include "MantidKernel/StringTokenizer.h"
#include "MantidKernel/Strings.h"
@@ -156,16 +157,10 @@ void ReflectometryReductionOne2::init() {
Direction::Input),
"Wavelength maximum in angstroms");
- // Init properties for monitors
initMonitorProperties();
-
- // Init properties for transmission normalization
+ initBackgroundProperties();
initTransmissionProperties();
-
- // Init properties for algorithmic corrections
initAlgorithmicProperties();
-
- // Init properties for diagnostics
initDebugProperties();
declareProperty(std::make_unique<WorkspaceProperty<>>("OutputWorkspace", "",
@@ -177,6 +172,11 @@ void ReflectometryReductionOne2::init() {
"OutputWorkspaceWavelength", "", Direction::Output,
PropertyMode::Optional),
"Output Workspace IvsLam. Intermediate workspace.");
+ setPropertySettings(
+ "OutputWorkspaceWavelength",
+ std::make_unique<Kernel::EnabledWhenProperty>("Debug", IS_EQUAL_TO, "1"));
+
+ initTransmissionOutputProperties();
}
/** Validate inputs
@@ -186,6 +186,9 @@ ReflectometryReductionOne2::validateInputs() {
std::map<std::string, std::string> results;
+ const auto background = validateBackgroundProperties();
+ results.insert(background.begin(), background.end());
+
const auto reduction = validateReductionProperties();
results.insert(reduction.begin(), reduction.end());
@@ -260,6 +263,7 @@ void ReflectometryReductionOne2::exec() {
// Convert to Q
auto IvsQ = convertToQ(IvsLam);
+ // Set outputs
if (!isDefault("OutputWorkspaceWavelength") || isChild()) {
setProperty("OutputWorkspaceWavelength", IvsLam);
}
@@ -397,9 +401,16 @@ MatrixWorkspace_sptr ReflectometryReductionOne2::makeIvsLam() {
result = cropWavelength(result, true, wavelengthMin(), wavelengthMax());
outputDebugWorkspace(result, wsName, "_cropped", debug, step);
} else {
+ g_log.debug("Extracting ROI\n");
+ result = makeDetectorWS(result, false, false);
+ outputDebugWorkspace(result, wsName, "_lambda", debug, step);
+ // Background subtraction
+ result = backgroundSubtraction(result);
+ outputDebugWorkspace(result, wsName, "_lambda_subtracted_bkg", debug, step);
+ // Sum in lambda
if (m_sum) {
g_log.debug("Summing in wavelength\n");
- result = makeDetectorWS(result, m_convertUnits);
+ result = makeDetectorWS(result, m_convertUnits, true);
outputDebugWorkspace(result, wsName, "_summed", debug, step);
}
// Now the workspace is in wavelength, find the min/max wavelength
@@ -458,6 +469,31 @@ ReflectometryReductionOne2::monitorCorrection(MatrixWorkspace_sptr detectorWS) {
return IvsLam;
}
+MatrixWorkspace_sptr ReflectometryReductionOne2::backgroundSubtraction(
+ MatrixWorkspace_sptr detectorWS) {
+ bool subtractBackground = getProperty("SubtractBackground");
+ if (!subtractBackground)
+ return detectorWS;
+ auto alg = this->createChildAlgorithm("ReflectometryBackgroundSubtraction");
+ alg->initialize();
+ alg->setProperty("InputWorkspace", detectorWS);
+ alg->setProperty("InputWorkspaceIndexType", "SpectrumNumber");
+ alg->setProperty("ProcessingInstructions",
+ getPropertyValue("BackgroundProcessingInstructions"));
+ alg->setProperty("BackgroundCalculationMethod",
+ getPropertyValue("BackgroundCalculationMethod"));
+ alg->setProperty("DegreeOfPolynomial",
+ getPropertyValue("DegreeOfPolynomial"));
+ alg->setProperty("CostFunction", getPropertyValue("CostFunction"));
+ // For our case, the peak range is the same as the main processing
+ // instructions, and we do the summation separately so don't sum the peak
+ alg->setProperty("PeakRange", getPropertyValue("ProcessingInstructions"));
+ alg->setProperty("SumPeak", false);
+ alg->execute();
+ MatrixWorkspace_sptr corrected = alg->getProperty("OutputWorkspace");
+ return corrected;
+}
+
/**
* Perform either transmission or algorithmic correction according to the
* settings.
@@ -493,6 +529,7 @@ MatrixWorkspace_sptr ReflectometryReductionOne2::transmissionCorrection(
MatrixWorkspace_sptr detectorWS, const bool detectorWSReduced) {
MatrixWorkspace_sptr transmissionWS = getProperty("FirstTransmissionRun");
+ auto transmissionWSName = transmissionWS->getName();
// Reduce the transmission workspace, if not already done (assume that if
// the workspace is in wavelength then it has already been reduced)
@@ -510,6 +547,7 @@ MatrixWorkspace_sptr ReflectometryReductionOne2::transmissionCorrection(
getPropertyValue("TransmissionProcessingInstructions");
}
+ bool const isDebug = getProperty("Debug");
MatrixWorkspace_sptr secondTransmissionWS =
getProperty("SecondTransmissionRun");
auto alg = this->createChildAlgorithm("CreateTransmissionWorkspace");
@@ -535,18 +573,14 @@ MatrixWorkspace_sptr ReflectometryReductionOne2::transmissionCorrection(
alg->setProperty("ProcessingInstructions", transmissionCommands);
alg->setProperty("NormalizeByIntegratedMonitors",
getPropertyValue("NormalizeByIntegratedMonitors"));
- alg->setPropertyValue("Debug", getPropertyValue("Debug"));
+ alg->setProperty("Debug", isDebug);
alg->execute();
transmissionWS = alg->getProperty("OutputWorkspace");
+ transmissionWSName = alg->getPropertyValue("OutputWorkspace");
- // Add the output transmission workspace to the ADS otherwise it gets
- // swallowed by this algorithm as it's not one of the output properties (it
- // might be better to make it an output property but currently users always
- // accept the default name so are unlikely to use it)
- auto transmissionWSName = alg->getPropertyValue("OutputWorkspace");
- if (!transmissionWSName.empty())
- AnalysisDataService::Instance().addOrReplace(transmissionWSName,
- transmissionWS);
+ // Set interim workspace outputs
+ setWorkspacePropertyFromChild(alg, "OutputWorkspaceFirstTransmission");
+ setWorkspacePropertyFromChild(alg, "OutputWorkspaceSecondTransmission");
}
// Rebin the transmission run to be the same as the input.
@@ -564,6 +598,13 @@ MatrixWorkspace_sptr ReflectometryReductionOne2::transmissionCorrection(
}
MatrixWorkspace_sptr normalized = divide(detectorWS, transmissionWS);
+
+ // Set output transmission workspace
+ if (isDefault("OutputWorkspaceTransmission") && !transmissionWSName.empty()) {
+ setPropertyValue("OutputWorkspaceTransmission", transmissionWSName);
+ }
+ setProperty("OutputWorkspaceTransmission", transmissionWS);
+
return normalized;
}
diff --git a/Framework/Algorithms/src/ReflectometryReductionOneAuto3.cpp b/Framework/Algorithms/src/ReflectometryReductionOneAuto3.cpp
index c953350b588eef7e06738d21925a30127a854e81..952f0173fd82b48d300133a34a1f0fd2701510f7 100644
--- a/Framework/Algorithms/src/ReflectometryReductionOneAuto3.cpp
+++ b/Framework/Algorithms/src/ReflectometryReductionOneAuto3.cpp
@@ -297,16 +297,10 @@ void ReflectometryReductionOneAuto3::init() {
declareProperty("WavelengthMax", Mantid::EMPTY_DBL(),
"Wavelength Max in angstroms", Direction::Input);
- // Monitor properties
initMonitorProperties();
-
- // Init properties for transmission normalization
+ initBackgroundProperties();
initTransmissionProperties();
-
- // Init properties for algorithmic corrections
initAlgorithmicProperties(true);
-
- // Momentum transfer properties
initMomentumTransferProperties();
// Polarization correction
@@ -348,6 +342,11 @@ void ReflectometryReductionOneAuto3::init() {
"OutputWorkspaceWavelength", "", Direction::Output,
PropertyMode::Optional),
"Output workspace in wavelength");
+ setPropertySettings(
+ "OutputWorkspaceWavelength",
+ std::make_unique<Kernel::EnabledWhenProperty>("Debug", IS_EQUAL_TO, "1"));
+
+ initTransmissionOutputProperties();
}
/** Execute the algorithm.
@@ -358,8 +357,9 @@ void ReflectometryReductionOneAuto3::exec() {
MatrixWorkspace_sptr inputWS = getProperty("InputWorkspace");
auto instrument = inputWS->getInstrument();
+ bool const isDebug = getProperty("Debug");
- IAlgorithm_sptr alg = createChildAlgorithm("ReflectometryReductionOne");
+ Algorithm_sptr alg = createChildAlgorithm("ReflectometryReductionOne");
alg->initialize();
// Mandatory properties
alg->setProperty("SummationType", getPropertyValue("SummationType"));
@@ -367,7 +367,7 @@ void ReflectometryReductionOneAuto3::exec() {
alg->setProperty("IncludePartialBins",
getPropertyValue("IncludePartialBins"));
alg->setProperty("Diagnostics", getPropertyValue("Diagnostics"));
- alg->setProperty("Debug", getPropertyValue("Debug"));
+ alg->setProperty("Debug", isDebug);
double wavMin = checkForMandatoryInstrumentDefault<double>(
this, "WavelengthMin", instrument, "LambdaMin");
alg->setProperty("WavelengthMin", wavMin);
@@ -412,6 +412,16 @@ void ReflectometryReductionOneAuto3::exec() {
if (!transRunsFound)
populateAlgorithmicCorrectionProperties(alg, instrument);
+ alg->setPropertyValue("SubtractBackground",
+ getPropertyValue("SubtractBackground"));
+ alg->setPropertyValue("BackgroundProcessingInstructions",
+ getPropertyValue("BackgroundProcessingInstructions"));
+ alg->setPropertyValue("BackgroundCalculationMethod",
+ getPropertyValue("BackgroundCalculationMethod"));
+ alg->setPropertyValue("DegreeOfPolynomial",
+ getPropertyValue("DegreeOfPolynomial"));
+ alg->setPropertyValue("CostFunction", getPropertyValue("CostFunction"));
+
alg->setProperty("InputWorkspace", inputWS);
alg->execute();
@@ -433,12 +443,16 @@ void ReflectometryReductionOneAuto3::exec() {
}
// Set the output workspace in wavelength, if debug outputs are enabled
- const bool isDebug = getProperty("Debug");
- if (isDebug || isChild()) {
+ if (!isDefault("OutputWorkspaceWavelength") || isChild()) {
MatrixWorkspace_sptr IvsLam = alg->getProperty("OutputWorkspaceWavelength");
setProperty("OutputWorkspaceWavelength", IvsLam);
}
+ // Set the output transmission workspaces
+ setWorkspacePropertyFromChild(alg, "OutputWorkspaceTransmission");
+ setWorkspacePropertyFromChild(alg, "OutputWorkspaceFirstTransmission");
+ setWorkspacePropertyFromChild(alg, "OutputWorkspaceSecondTransmission");
+
// Set other properties so they can be updated in the Reflectometry interface
setProperty("ThetaIn", theta);
setProperty("MomentumTransferMin", params.qMin);
diff --git a/Framework/Algorithms/src/ReflectometryWorkflowBase2.cpp b/Framework/Algorithms/src/ReflectometryWorkflowBase2.cpp
index 4f5cc9a47ffaa84fec901c0257d7a2c862ca577d..262aff90e31d5dc93ac4884a4471b2e866bdc000 100644
--- a/Framework/Algorithms/src/ReflectometryWorkflowBase2.cpp
+++ b/Framework/Algorithms/src/ReflectometryWorkflowBase2.cpp
@@ -18,6 +18,7 @@
#include "MantidKernel/ListValidator.h"
#include "MantidKernel/MandatoryValidator.h"
#include "MantidKernel/RebinParamsValidator.h"
+#include "MantidKernel/Strings.h"
#include "MantidKernel/TimeSeriesProperty.h"
#include "MantidKernel/Unit.h"
@@ -37,6 +38,60 @@ int convertStringNumToInt(const std::string &string) {
"Out of range value given for processing instructions");
}
}
+
+std::string convertToWorkspaceIndex(const std::string &spectrumNumber,
+ MatrixWorkspace_const_sptr ws) {
+ auto specNum = convertStringNumToInt(spectrumNumber);
+ std::string wsIdx = std::to_string(
+ ws->getIndexFromSpectrumNumber(static_cast<Mantid::specnum_t>(specNum)));
+ return wsIdx;
+}
+
+std::string
+convertProcessingInstructionsToWorkspaceIndices(const std::string &instructions,
+ MatrixWorkspace_const_sptr ws) {
+ std::string converted = "";
+ std::string currentNumber = "";
+ std::string ignoreThese = "-,:+";
+ for (const char instruction : instructions) {
+ if (std::find(ignoreThese.begin(), ignoreThese.end(), instruction) !=
+ ignoreThese.end()) {
+ // Found a spacer so add currentNumber to converted followed by separator
+ converted.append(convertToWorkspaceIndex(currentNumber, ws));
+ converted.push_back(instruction);
+ currentNumber = "";
+ } else {
+ currentNumber.push_back(instruction);
+ }
+ }
+ // Add currentNumber onto converted
+ converted.append(convertToWorkspaceIndex(currentNumber, ws));
+ return converted;
+}
+
+/** Convert processing instructions given as spectrum numbers to a vector of
+ * workspace indices
+ * @param instructions : the processing instructions in spectrum numbers in the
+ * grouping format used by GroupDetectors
+ * @param workspace : the workspace the instructions apply to
+ * @returns : a vector of indices of the requested spectra in the given
+ * workspace
+ */
+std::vector<size_t>
+getProcessingInstructionsAsIndices(std::string const &instructions,
+ MatrixWorkspace_sptr workspace) {
+ auto instructionsInWSIndex =
+ convertProcessingInstructionsToWorkspaceIndices(instructions, workspace);
+ auto groups =
+ Mantid::Kernel::Strings::parseGroups<size_t>(instructionsInWSIndex);
+ auto indices = std::vector<size_t>();
+ std::for_each(groups.cbegin(), groups.cend(),
+ [&indices](std::vector<size_t> const &groupIndices) -> void {
+ indices.insert(indices.begin(), groupIndices.cbegin(),
+ groupIndices.cend());
+ });
+ return indices;
+}
} // namespace
namespace Mantid {
@@ -120,6 +175,40 @@ void ReflectometryWorkflowBase2::initMonitorProperties() {
"Normalize by dividing by the integrated monitors.");
}
+/** Initialize properties related to transmission normalization
+ */
+void ReflectometryWorkflowBase2::initBackgroundProperties() {
+
+ declareProperty(std::make_unique<PropertyWithValue<bool>>(
+ "SubtractBackground", false, Direction::Input),
+ "If true then perform background subtraction");
+ declareProperty(
+ std::make_unique<PropertyWithValue<std::string>>(
+ "BackgroundProcessingInstructions", "", Direction::Input),
+ "These processing instructions will be passed to the background "
+ "subtraction algorithm");
+
+ auto algBkg = AlgorithmManager::Instance().createUnmanaged(
+ "ReflectometryBackgroundSubtraction");
+ algBkg->initialize();
+ copyProperty(algBkg, "BackgroundCalculationMethod");
+ copyProperty(algBkg, "DegreeOfPolynomial");
+ copyProperty(algBkg, "CostFunction");
+
+ setPropertySettings("BackgroundProcessingInstructions",
+ std::make_unique<Kernel::EnabledWhenProperty>(
+ "SubtractBackground", IS_EQUAL_TO, "1"));
+ setPropertySettings("BackgroundCalculationMethod",
+ std::make_unique<Kernel::EnabledWhenProperty>(
+ "SubtractBackground", IS_EQUAL_TO, "1"));
+
+ setPropertyGroup("SubtractBackground", "Background");
+ setPropertyGroup("BackgroundProcessingInstructions", "Background");
+ setPropertyGroup("BackgroundCalculationMethod", "Background");
+ setPropertyGroup("DegreeOfPolynomial", "Background");
+ setPropertyGroup("CostFunction", "Background");
+}
+
/** Initialize properties related to transmission normalization
*/
void ReflectometryWorkflowBase2::initTransmissionProperties() {
@@ -152,6 +241,33 @@ void ReflectometryWorkflowBase2::initTransmissionProperties() {
setPropertyGroup("StartOverlap", "Transmission");
setPropertyGroup("EndOverlap", "Transmission");
setPropertyGroup("ScaleRHSWorkspace", "Transmission");
+ setPropertyGroup("TransmissionProcessingInstructions", "Transmission");
+}
+
+/** Initialize output properties related to transmission normalization
+ */
+void ReflectometryWorkflowBase2::initTransmissionOutputProperties() {
+ // Add additional output workspace properties
+ declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
+ "OutputWorkspaceTransmission", "", Direction::Output,
+ PropertyMode::Optional),
+ "Output transmissison workspace in wavelength");
+ declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
+ "OutputWorkspaceFirstTransmission", "", Direction::Output,
+ PropertyMode::Optional),
+ "First transmissison workspace in wavelength");
+ declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>(
+ "OutputWorkspaceSecondTransmission", "",
+ Direction::Output, PropertyMode::Optional),
+ "Second transmissison workspace in wavelength");
+
+ // Specify conditional output properties for when debug is on
+ setPropertySettings(
+ "OutputWorkspaceFirstTransmission",
+ std::make_unique<Kernel::EnabledWhenProperty>("Debug", IS_EQUAL_TO, "1"));
+ setPropertySettings(
+ "OutputWorkspaceSecondTransmission",
+ std::make_unique<Kernel::EnabledWhenProperty>("Debug", IS_EQUAL_TO, "1"));
}
/** Initialize properties used for stitching transmission runs
@@ -246,13 +362,31 @@ void ReflectometryWorkflowBase2::initMomentumTransferProperties() {
/** Initialize properties for diagnostics
*/
void ReflectometryWorkflowBase2::initDebugProperties() {
- // Diagnostics
+ declareProperty("Debug", false,
+ "Whether to enable the output of extra workspaces.");
declareProperty("Diagnostics", false,
"Whether to enable the output of "
"interim workspaces for debugging "
"purposes.");
- declareProperty("Debug", false,
- "Whether to enable the output of extra workspaces.");
+}
+
+/** Validate background properties, if given
+ *
+ * @return :: A map with results of validation
+ */
+std::map<std::string, std::string>
+ReflectometryWorkflowBase2::validateBackgroundProperties() const {
+
+ std::map<std::string, std::string> results;
+
+ const bool subtractBackground = getProperty("SubtractBackground");
+ const std::string summationType = getProperty("SummationType");
+ if (subtractBackground && summationType == "SumInQ") {
+ results["SubtractBackground"] =
+ "Background subtraction is not implemented if summing in Q";
+ }
+
+ return results;
}
/** Validate reduction properties, if given
@@ -444,18 +578,45 @@ MatrixWorkspace_sptr ReflectometryWorkflowBase2::cropWavelength(
* to get a detector workspace in wavelength.
* @param inputWS :: the input workspace in TOF
* @param convert :: whether the result should be converted to wavelength
+ * @param sum :: whether the detectors should be summed into a single spectrum
* @return :: the detector workspace in wavelength
*/
MatrixWorkspace_sptr
ReflectometryWorkflowBase2::makeDetectorWS(MatrixWorkspace_sptr inputWS,
- const bool convert) {
- auto groupAlg = createChildAlgorithm("GroupDetectors");
- groupAlg->initialize();
- groupAlg->setProperty("GroupingPattern",
- m_processingInstructionsWorkspaceIndex);
- groupAlg->setProperty("InputWorkspace", inputWS);
- groupAlg->execute();
- MatrixWorkspace_sptr detectorWS = groupAlg->getProperty("OutputWorkspace");
+ const bool convert, const bool sum) {
+ auto detectorWS = inputWS;
+
+ if (sum) {
+ // Use GroupDetectors to extract and sum the detectors of interest
+ auto groupAlg = createChildAlgorithm("GroupDetectors");
+ groupAlg->initialize();
+ groupAlg->setProperty("GroupingPattern",
+ m_processingInstructionsWorkspaceIndex);
+ groupAlg->setProperty("InputWorkspace", detectorWS);
+ groupAlg->execute();
+ detectorWS = groupAlg->getProperty("OutputWorkspace");
+ } else if (!isDefault("BackgroundProcessingInstructions")) {
+ // Extract the detectors for the ROI and background. Note that if background
+ // instructions are not set then we require the whole workspace so there is
+ // nothing to do.
+ auto indices = getProcessingInstructionsAsIndices(m_processingInstructions,
+ detectorWS);
+ auto bkgIndices = getProcessingInstructionsAsIndices(
+ getPropertyValue("BackgroundProcessingInstructions"), detectorWS);
+ indices.insert(indices.end(), bkgIndices.cbegin(), bkgIndices.cend());
+ std::sort(indices.begin(), indices.end());
+ indices.erase(std::unique(indices.begin(), indices.end()), indices.end());
+ auto extractAlg = createChildAlgorithm("ExtractSpectra");
+ extractAlg->initialize();
+ extractAlg->setProperty("InputWorkspace", detectorWS);
+ extractAlg->setProperty("WorkspaceIndexList", indices);
+ extractAlg->execute();
+ detectorWS = extractAlg->getProperty("OutputWorkspace");
+ // Update the workspace indicies to match the new workspace
+ m_processingInstructionsWorkspaceIndex =
+ convertProcessingInstructionsToWorkspaceIndices(
+ m_processingInstructions, detectorWS);
+ }
if (convert) {
detectorWS = convertToWavelength(detectorWS);
@@ -720,36 +881,6 @@ ReflectometryWorkflowBase2::getRunNumber(MatrixWorkspace const &ws) const {
return "";
}
-std::string
-ReflectometryWorkflowBase2::convertProcessingInstructionsToWorkspaceIndices(
- const std::string &instructions, MatrixWorkspace_const_sptr ws) const {
- std::string converted = "";
- std::string currentNumber = "";
- std::string ignoreThese = "-,:+";
- for (const char instruction : instructions) {
- if (std::find(ignoreThese.begin(), ignoreThese.end(), instruction) !=
- ignoreThese.end()) {
- // Found a spacer so add currentNumber to converted followed by separator
- converted.append(convertToWorkspaceIndex(currentNumber, ws));
- converted.push_back(instruction);
- currentNumber = "";
- } else {
- currentNumber.push_back(instruction);
- }
- }
- // Add currentNumber onto converted
- converted.append(convertToWorkspaceIndex(currentNumber, ws));
- return converted;
-}
-
-std::string ReflectometryWorkflowBase2::convertToWorkspaceIndex(
- const std::string &spectrumNumber, MatrixWorkspace_const_sptr ws) const {
- auto specNum = convertStringNumToInt(spectrumNumber);
- std::string wsIdx = std::to_string(
- ws->getIndexFromSpectrumNumber(static_cast<specnum_t>(specNum)));
- return wsIdx;
-}
-
std::string
ReflectometryWorkflowBase2::convertProcessingInstructionsToSpectrumNumbers(
const std::string &instructions,
@@ -803,5 +934,20 @@ void ReflectometryWorkflowBase2::convertProcessingInstructions(
convertProcessingInstructionsToWorkspaceIndices(m_processingInstructions,
inputWS);
}
+
+// Create an on-the-fly property to set an output workspace from a child
+// algorithm, if the child has that output value set
+void ReflectometryWorkflowBase2::setWorkspacePropertyFromChild(
+ Algorithm_sptr alg, std::string const &propertyName) {
+ if (alg->isDefault(propertyName))
+ return;
+
+ if (isDefault(propertyName)) {
+ std::string const workspaceName = alg->getPropertyValue(propertyName);
+ setPropertyValue(propertyName, workspaceName);
+ }
+ MatrixWorkspace_sptr workspace = alg->getProperty(propertyName);
+ setProperty(propertyName, workspace);
+}
} // namespace Algorithms
} // namespace Mantid
diff --git a/Framework/Algorithms/test/ApplyCalibrationTest.h b/Framework/Algorithms/test/ApplyCalibrationTest.h
index 1bb147ab2732aada482d7fdeb2efbb4a8f180912..c312a25db9176e1b4fa5fddef7a4d14379430b18 100644
--- a/Framework/Algorithms/test/ApplyCalibrationTest.h
+++ b/Framework/Algorithms/test/ApplyCalibrationTest.h
@@ -19,9 +19,12 @@
#include "MantidAlgorithms/ApplyCalibration.h"
#include "MantidDataHandling/LoadEmptyInstrument.h"
#include "MantidDataHandling/LoadInstrument.h"
+#include "MantidDataHandling/LoadRaw3.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidGeometry/Instrument.h"
#include "MantidGeometry/Instrument/Component.h"
+#include "MantidGeometry/Instrument/ComponentInfo.h"
+#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidKernel/V3D.h"
#include "MantidTestHelpers/WorkspaceCreationHelper.h"
@@ -35,17 +38,19 @@ using Mantid::Geometry::IDetector_const_sptr;
class ApplyCalibrationTest : public CxxTest::TestSuite {
public:
- void testName() { TS_ASSERT_EQUALS(appCalib.name(), "ApplyCalibration") }
+ void testName() {
+ ApplyCalibration appCalib;
+ TS_ASSERT_EQUALS(appCalib.name(), "ApplyCalibration")
+ }
void testInit() {
+ ApplyCalibration appCalib;
appCalib.initialize();
TS_ASSERT(appCalib.isInitialized())
}
void testSimple() {
-
int ndets = 3;
-
// Create workspace with paremeterised instrument and put into data store
Workspace2D_sptr ws =
WorkspaceCreationHelper::create2DWorkspaceWithFullInstrument(ndets, 10,
@@ -55,26 +60,35 @@ public:
dataStore.add(wsName, ws);
// Create Calibration Table
- ITableWorkspace_sptr posTableWs =
+ ITableWorkspace_sptr calTableWs =
WorkspaceFactory::Instance().createTable();
- posTableWs->addColumn("int", "Detector ID");
- posTableWs->addColumn("V3D", "Detector Position");
+ calTableWs->addColumn("int", "Detector ID");
+ calTableWs->addColumn("V3D", "Detector Position");
+ calTableWs->addColumn("double", "Detector Y Coordinate");
for (int i = 0; i < ndets; ++i) {
- TableRow row = posTableWs->appendRow();
- row << i + 1 << V3D(1.0, 0.01 * i, 2.0);
+ IDetector_const_sptr detector = ws->getDetector(i);
+ TableRow row = calTableWs->appendRow();
+ // detector-ID position Y-coordinate
+ row << detector->getID() << V3D(1.0, 0.01 * i, 2.0) << 0.04 * i;
}
+
+ ApplyCalibration appCalib;
+ appCalib.initialize();
TS_ASSERT_THROWS_NOTHING(appCalib.setPropertyValue("Workspace", wsName));
TS_ASSERT_THROWS_NOTHING(appCalib.setProperty<ITableWorkspace_sptr>(
- "PositionTable", posTableWs));
+ "CalibrationTable", calTableWs));
TS_ASSERT_THROWS_NOTHING(appCalib.execute());
TS_ASSERT(appCalib.isExecuted());
const auto &spectrumInfo = ws->spectrumInfo();
+ const auto &componentInfo = ws->componentInfo();
int id = spectrumInfo.detector(0).getID();
V3D newPos = spectrumInfo.position(0);
+ V3D scaleFactor = componentInfo.scaleFactor(0);
+
TS_ASSERT_EQUALS(id, 1);
TS_ASSERT_DELTA(newPos.X(), 1.0, 0.0001);
TS_ASSERT_DELTA(newPos.Y(), 0.0, 0.0001);
@@ -82,14 +96,95 @@ public:
id = spectrumInfo.detector(ndets - 1).getID();
newPos = spectrumInfo.position(ndets - 1);
+ scaleFactor = componentInfo.scaleFactor(0);
+
TS_ASSERT_EQUALS(id, ndets);
TS_ASSERT_DELTA(newPos.X(), 1.0, 0.0001);
- TS_ASSERT_DELTA(newPos.Y(), 0.01 * (ndets - 1), 0.0001);
+ TS_ASSERT_DELTA(newPos.Y(), 0.04 * (ndets - 1), 0.0001);
TS_ASSERT_DELTA(newPos.Z(), 2.0, 0.0001);
dataStore.remove(wsName);
}
+ /**
+ * Load a *.raw file and reset the detector position, width, and height for
+ * the first two spectra
+ */
+ void testCalibrateRawFile() {
+ // Create a calibration table
+ ITableWorkspace_sptr calTableWs =
+ WorkspaceFactory::Instance().createTable();
+ calTableWs->addColumn("int", "Detector ID");
+ calTableWs->addColumn("V3D", "Detector Position");
+ calTableWs->addColumn("double", "Detector Y Coordinate");
+ calTableWs->addColumn("double", "Detector Width");
+ calTableWs->addColumn("double", "Detector Height");
+
+ // Load the first two spectra from a *.raw data file into a workspace
+ const int nSpectra = 2;
+ const std::string wsName("applyCalibrationToRaw");
+ Mantid::DataHandling::LoadRaw3 loader;
+ loader.initialize();
+ loader.setPropertyValue("Filename", "HRP39180.RAW");
+ loader.setPropertyValue("OutputWorkspace", wsName);
+ loader.setPropertyValue("SpectrumMin",
+ "1"); // Spectrum number, not workspace index
+ loader.setPropertyValue("SpectrumMax", "9"); // std::to_string(nSpectra));
+ loader.execute();
+ AnalysisDataServiceImpl &dataStore = AnalysisDataService::Instance();
+ MatrixWorkspace_sptr workspace =
+ dataStore.retrieveWS<MatrixWorkspace>(wsName);
+ const auto &detectorInfo = workspace->detectorInfo();
+ const auto &componentInfo = workspace->componentInfo();
+
+ // Populate the calibration table with some final detector positions,
+ // widths, and heights
+ const std::vector<V3D> positions{V3D(0.20, 0.0, 0.42),
+ V3D(0.53, 0.0, 0.75)};
+ const std::vector<double> yCoords{0.31, 0.64};
+ const std::vector<double> widths{0.008, 0.007};
+ const std::vector<double> heights{0.041, 0.039};
+ for (size_t i = 0; i < nSpectra; i++) {
+ IDetector_const_sptr detector = workspace->getDetector(i);
+ const auto detectorID = detector->getID();
+ TableRow row = calTableWs->appendRow();
+ // insert data in the same order in which table columns were declared
+ // detector-ID position Y-coordinate Width Height
+ row << detectorID << positions[i] << yCoords[i] << widths[i]
+ << heights[i];
+ }
+
+ // Apply the calibration to the workspace
+ ApplyCalibration calibrationAlgorithm;
+ calibrationAlgorithm.initialize();
+ TS_ASSERT(calibrationAlgorithm.isInitialized())
+ TS_ASSERT_THROWS_NOTHING(
+ calibrationAlgorithm.setPropertyValue("Workspace", wsName));
+ TS_ASSERT_THROWS_NOTHING(
+ calibrationAlgorithm.setProperty<ITableWorkspace_sptr>(
+ "CalibrationTable", calTableWs));
+ TS_ASSERT_THROWS_NOTHING(calibrationAlgorithm.execute());
+ TS_ASSERT(calibrationAlgorithm.isExecuted());
+
+ // Assert the calibration
+ for (size_t i = 0; i < nSpectra; i++) {
+ // assert detector position
+ IDetector_const_sptr detector = workspace->getDetector(i);
+ const auto detectorID = detector->getID();
+ const auto &newPosition = detector->getPos();
+ TS_ASSERT_DELTA(newPosition.X(), positions[i].X(), 0.0001);
+ TS_ASSERT_DELTA(newPosition.Y(), yCoords[i], 0.0001);
+ TS_ASSERT_DELTA(newPosition.Z(), positions[i].Z(), 0.0001);
+ // assert detector width and height
+ const auto detectorIndex = detectorInfo.indexOf(detectorID);
+ const auto &scaleFactor = componentInfo.scaleFactor(detectorIndex);
+ const auto &box =
+ componentInfo.shape(detectorIndex).getBoundingBox().width();
+ TS_ASSERT_DELTA(scaleFactor.X() * box.X(), widths[i], 0.0001);
+ TS_ASSERT_DELTA(scaleFactor.Y() * box.Y(), heights[i], 0.0001);
+ }
+ }
+
void testComplex() {
/* The purpse of this test is to test the algorithm when the relative
* positioning and rotation
@@ -115,18 +210,22 @@ public:
// Create Calibration Table
int firstDetectorID = 34208002;
- ITableWorkspace_sptr posTableWs =
+ ITableWorkspace_sptr calTableWs =
WorkspaceFactory::Instance().createTable();
- posTableWs->addColumn("int", "Detector ID");
- posTableWs->addColumn("V3D", "Detector Position");
+ calTableWs->addColumn("int", "Detector ID");
+ calTableWs->addColumn("V3D", "Detector Position");
for (int i = 0; i < ndets; ++i) {
- TableRow row = posTableWs->appendRow();
+ TableRow row = calTableWs->appendRow();
+ // detector ID
row << firstDetectorID + 10 * i << V3D(1.0, 0.01 * i, 2.0);
}
+
+ ApplyCalibration appCalib;
+ appCalib.initialize();
TS_ASSERT_THROWS_NOTHING(appCalib.setPropertyValue("Workspace", wsName));
TS_ASSERT_THROWS_NOTHING(appCalib.setProperty<ITableWorkspace_sptr>(
- "PositionTable", posTableWs));
+ "CalibrationTable", calTableWs));
TS_ASSERT_THROWS_NOTHING(appCalib.execute());
TS_ASSERT(appCalib.isExecuted());
@@ -157,9 +256,6 @@ public:
dataStore.remove(wsName);
}
-
-private:
- ApplyCalibration appCalib;
};
#endif /*APPLYCALIBRATIONTEST_H_*/
diff --git a/Framework/Algorithms/test/CreateTransmissionWorkspace2Test.h b/Framework/Algorithms/test/CreateTransmissionWorkspace2Test.h
index 884cc312888b66d73af63615c9f465692bbe9181..b898f6541fcbf8c0daa0ab0039710b7d4b7ec1ed 100644
--- a/Framework/Algorithms/test/CreateTransmissionWorkspace2Test.h
+++ b/Framework/Algorithms/test/CreateTransmissionWorkspace2Test.h
@@ -399,58 +399,118 @@ public:
}
}
- void test_one_run_stores_output_in_ADS() {
+ void test_one_run_stores_output_workspace() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs(alg);
+ setup_test_to_check_output_workspaces(alg);
alg.setPropertyValue("OutputWorkspace", "outWS");
alg.execute();
check_stored_lambda_workspace("outWS");
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_1234"));
+ check_output_not_set(alg, "OutputWorkspaceFirstTransmission",
+ "TRANS_LAM_1234");
}
- void test_one_run_stores_output_in_ADS_with_default_name() {
+ void test_one_run_sets_output_workspace_when_child() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs(alg);
+ setup_test_to_check_output_workspaces(alg);
+ alg.setPropertyValue("OutputWorkspace", "outWS");
+ alg.setChild(true);
+ alg.execute();
+ check_output_lambda_workspace(alg, "OutputWorkspace", "outWS");
+ check_output_not_set(alg, "OutputWorkspaceFirstTransmission",
+ "TRANS_LAM_1234");
+ }
+
+ void test_one_run_stores_output_workspace_with_default_name() {
+ CreateTransmissionWorkspace2 alg;
+ setup_test_to_check_output_workspaces(alg);
alg.execute();
check_stored_lambda_workspace("TRANS_LAM_1234");
}
- void test_two_runs_stores_stitched_output_in_ADS() {
+ void test_one_run_sets_output_workspace_with_default_name_when_child() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg);
+ setup_test_to_check_output_workspaces(alg);
+ alg.setChild(true);
+ alg.execute();
+ check_output_lambda_workspace(alg, "OutputWorkspace", "TRANS_LAM_1234");
+ }
+
+ void test_two_runs_stores_stitched_output_workspace_only() {
+ CreateTransmissionWorkspace2 alg;
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
alg.setPropertyValue("OutputWorkspace", "outWS");
alg.execute();
check_stored_lambda_workspace("outWS");
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_4321"));
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_4321"));
+ check_output_not_set(alg, "OutputWorkspaceFirstTransmission",
+ "TRANS_LAM_1234");
+ check_output_not_set(alg, "OutputWorkspaceSecondTransmission",
+ "TRANS_LAM_4321");
+ }
+
+ void test_two_runs_does_not_set_interim_output_workspaces_when_child() {
+ CreateTransmissionWorkspace2 alg;
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
+ alg.setPropertyValue("OutputWorkspace", "outWS");
+ alg.setChild(true);
+ alg.execute();
+ check_output_lambda_workspace(alg, "OutputWorkspace", "outWS");
+ check_output_not_set(alg, "OutputWorkspaceFirstTransmission",
+ "TRANS_LAM_1234");
+ check_output_not_set(alg, "OutputWorkspaceSecondTransmission",
+ "TRANS_LAM_4321");
}
- void test_two_runs_stores_stitched_output_in_ADS_with_default_name() {
+ void test_two_runs_sets_all_output_workspaces_when_child_with_debug() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg);
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
+ alg.setPropertyValue("OutputWorkspace", "outWS");
+ alg.setChild(true);
+ alg.setProperty("Debug", true);
+ alg.execute();
+ check_output_lambda_workspace(alg, "OutputWorkspace", "outWS");
+ check_output_lambda_workspace(alg, "OutputWorkspaceFirstTransmission",
+ "TRANS_LAM_1234");
+ check_output_lambda_workspace(alg, "OutputWorkspaceSecondTransmission",
+ "TRANS_LAM_4321");
+ }
+
+ void test_two_runs_stores_stitched_output_workspace_with_default_name() {
+ CreateTransmissionWorkspace2 alg;
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
alg.execute();
check_stored_lambda_workspace("TRANS_LAM_1234_4321");
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_1234"));
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_4321"));
+ check_output_not_set(alg, "OutputWorkspaceFirstTransmission",
+ "TRANS_LAM_1234");
+ check_output_not_set(alg, "OutputWorkspaceSecondTransmission",
+ "TRANS_LAM_4321");
}
- void test_two_runs_stores_all_lambda_workspaces_in_ADS_with_debug() {
+ void
+ test_two_runs_sets_stitched_output_workspace_with_default_name_when_child() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg);
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
+ alg.setChild(true);
+ alg.execute();
+ check_output_lambda_workspace(alg, "OutputWorkspace",
+ "TRANS_LAM_1234_4321");
+ }
+
+ void test_two_runs_sets_all_output_workspaces_when_debug_enabled() {
+ CreateTransmissionWorkspace2 alg;
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
alg.setProperty("Debug", true);
alg.execute();
+ check_stored_lambda_workspace("TRANS_LAM_1234_4321");
check_stored_lambda_workspace("TRANS_LAM_1234");
check_stored_lambda_workspace("TRANS_LAM_4321");
- check_stored_lambda_workspace("TRANS_LAM_1234_4321");
}
void test_two_runs_stores_no_lambda_workspaces_in_ADS_when_child() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg);
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
alg.setChild(true);
alg.execute();
MatrixWorkspace_sptr outWS = alg.getProperty("OutputWorkspace");
- TS_ASSERT(outWS);
check_lambda_workspace(outWS);
TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_1234"));
TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_4321"));
@@ -459,67 +519,65 @@ public:
}
void
- test_two_runs_stores_interim_lambda_workspaces_in_ADS_when_child_with_debug() {
+ test_two_runs_stores_no_lambda_workspaces_in_ADS_when_child_with_debug() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg);
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
alg.setChild(true);
alg.setProperty("Debug", true);
alg.execute();
MatrixWorkspace_sptr outWS = alg.getProperty("OutputWorkspace");
- TS_ASSERT(outWS);
check_lambda_workspace(outWS);
- check_stored_lambda_workspace("TRANS_LAM_1234");
- check_stored_lambda_workspace("TRANS_LAM_4321");
+ TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_1234"));
+ TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_4321"));
TS_ASSERT(
!AnalysisDataService::Instance().doesExist("TRANS_LAM_1234_4321"));
}
- void test_first_trans_run_not_stored_if_name_not_found() {
+ void test_two_runs_sets_interim_lambda_output_workspaces_when_debug() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg, false, true);
+ setup_test_to_check_output_workspaces_with_2_inputs(alg);
alg.setProperty("Debug", true);
alg.execute();
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_1234"));
+ check_stored_lambda_workspace("TRANS_LAM_1234_4321");
+ check_stored_lambda_workspace("TRANS_LAM_1234");
check_stored_lambda_workspace("TRANS_LAM_4321");
}
- void test_second_trans_run_not_stored_if_name_not_found() {
+ void test_throws_if_first_trans_name_not_found() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg, true, false);
+ setup_test_to_check_output_workspaces_with_2_inputs(alg, false, true);
alg.setProperty("Debug", true);
alg.execute();
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_4321"));
- check_stored_lambda_workspace("TRANS_LAM_1234");
+ TS_ASSERT_EQUALS(alg.isExecuted(), false);
}
- void test_stitched_trans_run_not_stored_if_first_name_not_found() {
+ void test_throws_if_first_trans_name_not_found_when_child() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg, false, true);
- alg.execute();
- TS_ASSERT(
- !AnalysisDataService::Instance().doesExist("TRANS_LAM_1234_4321"));
+ setup_test_to_check_output_workspaces_with_2_inputs(alg, false, true);
+ alg.setProperty("Debug", true);
+ alg.setChild(true);
+ TS_ASSERT_THROWS_ANYTHING(alg.execute());
}
- void test_stitched_trans_run_not_stored_if_second_name_not_found() {
+ void test_throws_if_second_trans_name_not_found() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg, true, false);
+ setup_test_to_check_output_workspaces_with_2_inputs(alg, true, false);
+ alg.setProperty("Debug", true);
alg.execute();
- TS_ASSERT(
- !AnalysisDataService::Instance().doesExist("TRANS_LAM_1234_4321"));
+ TS_ASSERT_EQUALS(alg.isExecuted(), false);
}
- void test_output_workspace_is_still_returned_even_if_name_not_found() {
+ void test_throws_if_second_trans_name_not_found_when_child() {
CreateTransmissionWorkspace2 alg;
- setup_test_to_check_stored_runs_with_2_inputs(alg, false, true);
- alg.execute();
- MatrixWorkspace_sptr outWS = alg.getProperty("OutputWorkspace");
- TS_ASSERT(outWS);
- check_lambda_workspace(outWS);
+ setup_test_to_check_output_workspaces_with_2_inputs(alg, true, false);
+ alg.setProperty("Debug", true);
+ alg.setChild(true);
+ TS_ASSERT_THROWS_ANYTHING(alg.execute());
}
private:
- void setup_test_to_check_stored_runs(CreateTransmissionWorkspace2 &alg,
- bool hasRunNumber = true) {
+ void setup_test_to_check_output_workspaces(CreateTransmissionWorkspace2 &alg,
+ bool hasRunNumber = true) {
AnalysisDataService::Instance().clear();
auto inputWS = MatrixWorkspace_sptr(m_multiDetectorWS->clone());
if (hasRunNumber)
@@ -532,29 +590,49 @@ private:
alg.setPropertyValue("ProcessingInstructions", "2");
}
- void setup_test_to_check_stored_runs_with_2_inputs(
+ void setup_test_to_check_output_workspaces_with_2_inputs(
CreateTransmissionWorkspace2 &alg, bool firstHasRunNumber = true,
bool secondHasRunNumber = true) {
- setup_test_to_check_stored_runs(alg, firstHasRunNumber);
+ setup_test_to_check_output_workspaces(alg, firstHasRunNumber);
auto inputWS2 = MatrixWorkspace_sptr(m_multiDetectorWS->clone());
if (secondHasRunNumber)
inputWS2->mutableRun().addProperty<std::string>("run_number", "4321");
alg.setProperty("SecondTransmissionRun", inputWS2);
}
+ void check_output_lambda_workspace(CreateTransmissionWorkspace2 const &alg,
+ std::string const &propertyName,
+ std::string const &name) {
+ TS_ASSERT_EQUALS(alg.getPropertyValue(propertyName), name);
+ MatrixWorkspace_sptr outWS = alg.getProperty(propertyName);
+ check_lambda_workspace(outWS);
+ }
+
void check_stored_lambda_workspace(std::string const &name) {
- TS_ASSERT(AnalysisDataService::Instance().doesExist(name));
- MatrixWorkspace_sptr ws =
- AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(name);
- check_lambda_workspace(ws);
+ auto exists = AnalysisDataService::Instance().doesExist(name);
+ TS_ASSERT(exists);
+ if (exists) {
+ auto ws =
+ AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(name);
+ check_lambda_workspace(ws);
+ }
}
void check_lambda_workspace(MatrixWorkspace_sptr ws) {
TS_ASSERT(ws);
+ if (!ws)
+ return;
TS_ASSERT_EQUALS(ws->getAxis(0)->unit()->unitID(), "Wavelength");
TS_ASSERT(ws->x(0).front() >= 3.0);
TS_ASSERT(ws->x(0).back() <= 12.0);
}
+
+ void check_output_not_set(CreateTransmissionWorkspace2 const &alg,
+ std::string const &propertyName,
+ std::string const &name) {
+ TS_ASSERT(alg.isDefault(propertyName));
+ TS_ASSERT(!AnalysisDataService::Instance().doesExist(name));
+ }
};
#endif /* ALGORITHMS_TEST_CREATETRANSMISSIONWORKSPACE2TEST_H_ */
diff --git a/Framework/Algorithms/test/ReflectometryBackgroundSubtractionTest.py b/Framework/Algorithms/test/ReflectometryBackgroundSubtractionTest.py
index 59f72e2786d0a0b22c3fb679774ba4a9c7d67bc0..8e77af5f13430685845ad282d18c52dd553dd0ff 100644
--- a/Framework/Algorithms/test/ReflectometryBackgroundSubtractionTest.py
+++ b/Framework/Algorithms/test/ReflectometryBackgroundSubtractionTest.py
@@ -50,7 +50,7 @@ class ReflectometryBackgroundSubtractionTest(unittest.TestCase):
Check that the algorithm the correct output using background method AveragePixelFit
"""
args = {'InputWorkspace' : 'workspace_with_peak',
- 'ProcesssingInstructions' : '0-2,5-7',
+ 'ProcessingInstructions' : '0-2,5-7',
'BackgroundCalculationMethod' : 'PerDetectorAverage',
'OutputWorkspace': 'output'}
output = self._assert_run_algorithm_succeeds(args)
@@ -67,7 +67,7 @@ class ReflectometryBackgroundSubtractionTest(unittest.TestCase):
Check that the algorithm the correct output using background method Polynomial
"""
args = {'InputWorkspace' : 'workspace_with_peak',
- 'ProcesssingInstructions' : '0-2,5-7',
+ 'ProcessingInstructions' : '0-2,5-7',
'BackgroundCalculationMethod' : 'Polynomial',
'DegreeOfPolynomial' : '0',
'OutputWorkspace': 'output'}
@@ -85,7 +85,7 @@ class ReflectometryBackgroundSubtractionTest(unittest.TestCase):
Check that the algorithm the correct output using background method AveragePixelFit
"""
args = {'InputWorkspace' : 'workspace_with_peak',
- 'ProcesssingInstructions' : '0-7',
+ 'ProcessingInstructions' : '0-7',
'BackgroundCalculationMethod' : 'AveragePixelFit',
'PeakRange' : '3-4',
'SumPeak': False,
@@ -107,7 +107,7 @@ class ReflectometryBackgroundSubtractionTest(unittest.TestCase):
"""
args = {'InputWorkspace': 'workspace_with_peak',
'InputWorkspaceIndexType': 'SpectrumNumber',
- 'ProcesssingInstructions': '1-8',
+ 'ProcessingInstructions': '1-8',
'BackgroundCalculationMethod': 'AveragePixelFit',
'PeakRange': '4-5',
'SumPeak': False,
@@ -123,29 +123,31 @@ class ReflectometryBackgroundSubtractionTest(unittest.TestCase):
def test_Polynomial_error_for_single_spectra(self):
args = {'InputWorkspace' : 'workspace_with_peak',
- 'ProcesssingInstructions' : '3',
+ 'ProcessingInstructions' : '3',
'BackgroundCalculationMethod' : 'Polynomial'}
self._assert_run_algorithm_throws(args)
def test_AveragePixelFit_error_for_single_spectra(self):
args = {'InputWorkspace' : 'workspace_with_peak',
- 'ProcesssingInstructions' : '3',
+ 'ProcessingInstructions' : '3',
'BackgroundCalculationMethod' : 'AveragePixelFit',
'PeakRange' : '3-4',
'OutputWorkspace': 'output'}
self._assert_run_algorithm_throws(args)
- def test_AveragePixelFit_error_peakRange_outside_spectra(self):
- args = {'InputWorkspace' : 'workspace_with_peak',
- 'ProcesssingInstructions' : '1-7',
- 'BackgroundCalculationMethod' : 'AveragePixelFit',
- 'PeakRange' : '3-9',
- 'OutputWorkspace': 'output'}
- self._assert_run_algorithm_throws(args)
+ # TODO: This test fails in python 2. It can be re-added when we
+ # move fully to python 3.
+ #def test_AveragePixelFit_error_peakRange_outside_spectra(self):
+ # args = {'InputWorkspace' : 'workspace_with_peak',
+ # 'ProcessingInstructions' : '1-7',
+ # 'BackgroundCalculationMethod' : 'AveragePixelFit',
+ # 'PeakRange' : '3-9',
+ # 'OutputWorkspace': 'output'}
+ # self._assert_run_algorithm_invalid_property(args)
def test_AveragePixelFit_error_peakRange_two_ranges(self):
args = {'InputWorkspace' : 'workspace_with_peak',
- 'ProcesssingInstructions' : '1-7',
+ 'ProcessingInstructions' : '1-7',
'BackgroundCalculationMethod' : 'AveragePixelFit',
'PeakRange' : '2-4,6-7',
'OutputWorkspace': 'output'}
@@ -164,5 +166,10 @@ class ReflectometryBackgroundSubtractionTest(unittest.TestCase):
with self.assertRaises(RuntimeError):
alg.execute()
+ def _assert_run_algorithm_invalid_property(self, args = {}):
+ """Create the algorithm with the given args and check it fails"""
+ with self.assertRaises(ValueError):
+ create_algorithm('ReflectometryBackgroundSubtraction', **args)
+
if __name__ == '__main__':
unittest.main()
diff --git a/Framework/Algorithms/test/ReflectometryReductionOne2Test.h b/Framework/Algorithms/test/ReflectometryReductionOne2Test.h
index 2ab7a3aae98611417246ef4de6ca4cdae34fa837..44fcb73f897c27a371ac206f0882db3992c500a6 100644
--- a/Framework/Algorithms/test/ReflectometryReductionOne2Test.h
+++ b/Framework/Algorithms/test/ReflectometryReductionOne2Test.h
@@ -12,6 +12,8 @@
#include "MantidAPI/Axis.h"
#include "MantidAPI/FrameworkManager.h"
#include "MantidAPI/MatrixWorkspace.h"
+#include "MantidAPI/WorkspaceHistory.h"
+#include "MantidAlgorithms/CreateSampleWorkspace.h"
#include "MantidAlgorithms/ReflectometryReductionOne2.h"
#include "MantidGeometry/Instrument.h"
#include "MantidGeometry/Instrument/ReferenceFrame.h"
@@ -23,6 +25,7 @@
using namespace Mantid::API;
using namespace Mantid::Algorithms;
+using namespace Mantid::HistogramData;
using namespace WorkspaceCreationHelper;
class ReflectometryReductionOne2Test : public CxxTest::TestSuite {
@@ -61,7 +64,6 @@ public:
m_transmissionWS->getSpectrum(3).setSpectrumNo(5);
// Set different values in each spectrum so that we can check the correct
// spectra were used for the transmission correction
- using namespace Mantid::HistogramData;
m_transmissionWS->setCounts(0, Counts(m_transmissionWS->y(0).size(), 10));
m_transmissionWS->setCounts(1, Counts(m_transmissionWS->y(1).size(), 20));
m_transmissionWS->setCounts(2, Counts(m_transmissionWS->y(2).size(), 30));
@@ -845,7 +847,8 @@ public:
false);
runAlgorithmLam(alg);
- TS_ASSERT(AnalysisDataService::Instance().doesExist("TRANS_LAM_1234"));
+ TS_ASSERT_EQUALS(alg.getPropertyValue("OutputWorkspaceTransmission"),
+ "TRANS_LAM_1234");
AnalysisDataService::Instance().clear();
}
@@ -856,14 +859,91 @@ public:
true);
runAlgorithmLam(alg);
- // stitched output is stored
- TS_ASSERT(AnalysisDataService::Instance().doesExist("TRANS_LAM_1234_1234"));
- // interim outputs are not
+ // stitched transmission output is set
+ TS_ASSERT_EQUALS(alg.getPropertyValue("OutputWorkspaceTransmission"),
+ "TRANS_LAM_1234_1234");
+ // interim transmission outputs are not set
+ TS_ASSERT(alg.isDefault("OutputWorkspaceFirstTransmission"));
+ TS_ASSERT(alg.isDefault("OutputWorkspaceSecondTransmission"));
TS_ASSERT(!AnalysisDataService::Instance().doesExist("TRANS_LAM_1234"));
AnalysisDataService::Instance().clear();
}
+ void
+ test_background_subtraction_not_done_if_not_enabled_even_if_background_properties_set() {
+ ReflectometryReductionOne2 alg;
+ setupAlgorithmForBackgroundSubtraction(
+ alg, createWorkspaceWithFlatBackground("test_ws"));
+ alg.setProperty("SubtractBackground", false);
+ alg.setProperty("BackgroundProcessingInstructions", "1");
+ alg.setProperty("BackgroundCalculationMethod", "PerDetectorAverage");
+ alg.execute();
+ auto outputWS = boost::dynamic_pointer_cast<MatrixWorkspace>(
+ AnalysisDataService::Instance().retrieve("IvsQ"));
+ checkWorkspaceHistory(outputWS,
+ {"ExtractSpectra", "GroupDetectors", "ConvertUnits",
+ "CropWorkspace", "ConvertUnits"});
+ }
+
+ void test_background_subtraction_with_default_properties() {
+ ReflectometryReductionOne2 alg;
+ setupAlgorithmForBackgroundSubtraction(
+ alg, createWorkspaceWithFlatBackground("test_ws"));
+ alg.execute();
+ auto outputWS = boost::dynamic_pointer_cast<MatrixWorkspace>(
+ AnalysisDataService::Instance().retrieve("IvsQ"));
+ // Note that ExtractSpectra is not called because the whole workspace is
+ // used for the background subtraction
+ checkWorkspaceHistory(outputWS, {"ReflectometryBackgroundSubtraction",
+ "GroupDetectors", "ConvertUnits",
+ "CropWorkspace", "ConvertUnits"});
+ checkHistoryAlgorithmProperties(
+ outputWS, 1, 0,
+ {{"ProcessingInstructions", ""},
+ {"BackgroundCalculationMethod", "PerDetectorAverage"}});
+ }
+
+ void test_subtract_flat_background() {
+ ReflectometryReductionOne2 alg;
+ setupAlgorithmForBackgroundSubtraction(
+ alg, createWorkspaceWithFlatBackground("test_ws"));
+ alg.setProperty("BackgroundProcessingInstructions", "1, 2, 4, 5");
+ alg.setProperty("BackgroundCalculationMethod", "PerDetectorAverage");
+ alg.execute();
+ auto outputWS = boost::dynamic_pointer_cast<MatrixWorkspace>(
+ AnalysisDataService::Instance().retrieve("IvsQ"));
+ checkWorkspaceHistory(outputWS, {"ExtractSpectra",
+ "ReflectometryBackgroundSubtraction",
+ "GroupDetectors", "ConvertUnits",
+ "CropWorkspace", "ConvertUnits"});
+ checkHistoryAlgorithmProperties(
+ outputWS, 1, 1,
+ {{"ProcessingInstructions", "1-2,4-5"},
+ {"BackgroundCalculationMethod", "PerDetectorAverage"}});
+ }
+
+ void test_subtract_polynomial_background() {
+ ReflectometryReductionOne2 alg;
+ setupAlgorithmForBackgroundSubtraction(
+ alg, createWorkspaceWithPolynomialBackground("test_ws"));
+ alg.setProperty("BackgroundProcessingInstructions", "1-4, 6-8");
+ alg.setProperty("BackgroundCalculationMethod", "Polynomial");
+ alg.setProperty("DegreeOfPolynomial", "2");
+ alg.execute();
+ auto outputWS = boost::dynamic_pointer_cast<MatrixWorkspace>(
+ AnalysisDataService::Instance().retrieve("IvsQ"));
+ checkWorkspaceHistory(outputWS, {"ExtractSpectra",
+ "ReflectometryBackgroundSubtraction",
+ "GroupDetectors", "ConvertUnits",
+ "CropWorkspace", "ConvertUnits"});
+ checkHistoryAlgorithmProperties(
+ outputWS, 1, 1,
+ {{"ProcessingInstructions", "1-4,6-8"},
+ {"BackgroundCalculationMethod", "Polynomial"},
+ {"DegreeOfPolynomial", "2"}});
+ }
+
private:
// Do standard algorithm setup
void setupAlgorithm(ReflectometryReductionOne2 &alg,
@@ -918,6 +998,16 @@ private:
}
}
+ void setupAlgorithmForBackgroundSubtraction(ReflectometryReductionOne2 &alg,
+ MatrixWorkspace_sptr inputWS) {
+ setupAlgorithm(alg, 0, 5, "3");
+ alg.setChild(false); // required to get history
+ alg.setProperty("InputWorkspace", inputWS);
+ alg.setProperty("ThetaIn", 0.5);
+ alg.setProperty("I0MonitorIndex", 1);
+ alg.setProperty("SubtractBackground", true);
+ }
+
// Do standard algorithm execution and checks and return IvsLam
MatrixWorkspace_sptr runAlgorithmLam(ReflectometryReductionOne2 &alg,
const size_t blocksize = 14,
@@ -954,6 +1044,102 @@ private:
}
}
}
+
+ MatrixWorkspace_sptr
+ createWorkspaceWithFlatBackground(std::string const &name) {
+ // Create a workspace with a background of 2 and a peak of 5 in the 2nd
+ // index
+ auto const nspec = 4;
+ auto const background = Counts(nspec, 2);
+ auto const peak = Counts(nspec, 5);
+
+ CreateSampleWorkspace alg;
+ alg.initialize();
+ alg.setChild(false);
+ alg.setProperty("NumBanks", nspec + 1);
+ alg.setProperty("BankPixelWidth", 1);
+ alg.setProperty("XMin", 1.0);
+ alg.setProperty("XMax", 5.0);
+ alg.setProperty("BinWidth", 1.0);
+ alg.setProperty("XUnit", "TOF");
+ alg.setProperty("WorkspaceType", "Histogram");
+ alg.setProperty("NumMonitors", 0);
+ alg.setPropertyValue("OutputWorkspace", name);
+ alg.execute();
+
+ auto ws = boost::dynamic_pointer_cast<MatrixWorkspace>(
+ AnalysisDataService::Instance().retrieve(name));
+ ws->setCounts(0, background);
+ ws->setCounts(1, background);
+ ws->setCounts(2, peak);
+ ws->setCounts(3, background);
+ ws->setCounts(4, background);
+ return ws;
+ }
+
+ MatrixWorkspace_sptr
+ createWorkspaceWithPolynomialBackground(std::string const &name) {
+ // Create a workspace with a polynomial background of degree 2 and a peak
+ // of 5 in the 5th spectra
+ auto const nspec = 9;
+ auto const polynomial = std::vector<int>{1, 8, 13, 16, 17, 16, 13, 8, 1};
+ auto const peak = std::vector<int>{0, 0, 0, 0, 5, 0, 0, 0, 0};
+
+ CreateSampleWorkspace alg;
+ alg.initialize();
+ alg.setChild(false);
+ alg.setProperty("NumBanks", nspec);
+ alg.setProperty("BankPixelWidth", 1);
+ alg.setProperty("XMin", 1.0);
+ alg.setProperty("XMax", 2.0);
+ alg.setProperty("BinWidth", 1.0);
+ alg.setProperty("XUnit", "TOF");
+ alg.setProperty("WorkspaceType", "Histogram");
+ alg.setProperty("NumMonitors", 0);
+ alg.setProperty("OutputWorkspace", name);
+ alg.execute();
+
+ auto ws = boost::dynamic_pointer_cast<MatrixWorkspace>(
+ AnalysisDataService::Instance().retrieve(name));
+ for (auto spec = 0; spec < nspec; ++spec)
+ ws->setCounts(spec, Counts(1, polynomial[spec] + peak[spec]));
+ return ws;
+ }
+
+ void checkWorkspaceHistory(MatrixWorkspace_sptr ws,
+ std::vector<std::string> const &expected,
+ bool const unroll = true) {
+ auto wsHistory = ws->getHistory();
+ auto algHistories = wsHistory.getAlgorithmHistories();
+ auto algNames = std::vector<std::string>();
+ if (unroll && algHistories.size() > 0) {
+ auto lastAlgHistory = algHistories.back();
+ auto childHistories = lastAlgHistory->getChildHistories();
+ std::transform(childHistories.cbegin(), childHistories.cend(),
+ std::back_inserter(algNames),
+ [](AlgorithmHistory_const_sptr childAlg) {
+ return childAlg->name();
+ });
+ } else if (!unroll) {
+ std::transform(algHistories.cbegin(), algHistories.cend(),
+ std::back_inserter(algNames),
+ [](AlgorithmHistory_sptr alg) { return alg->name(); });
+ }
+ TS_ASSERT_EQUALS(algNames, expected);
+ }
+
+ void checkHistoryAlgorithmProperties(
+ MatrixWorkspace_sptr ws, size_t toplevelIdx, size_t childIdx,
+ std::map<std::string, std::string> const &expected) {
+ auto parentHist = ws->getHistory().getAlgorithmHistory(toplevelIdx);
+ auto childHistories = parentHist->getChildHistories();
+ TS_ASSERT(childHistories.size() > childIdx);
+ if (childIdx >= childHistories.size())
+ return;
+ auto childHist = childHistories[childIdx];
+ for (auto kvp : expected)
+ TS_ASSERT_EQUALS(childHist->getPropertyValue(kvp.first), kvp.second);
+ }
};
#endif /* ALGORITHMS_TEST_REFLECTOMETRYREDUCTIONONE2TEST_H_ */
diff --git a/Framework/Algorithms/test/ReflectometryReductionOne2Test.py b/Framework/Algorithms/test/ReflectometryReductionOne2Test.py
new file mode 100644
index 0000000000000000000000000000000000000000..c829965c76da4d96ed4da5bde474ff9bfcc60ad9
--- /dev/null
+++ b/Framework/Algorithms/test/ReflectometryReductionOne2Test.py
@@ -0,0 +1,85 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+import unittest
+from mantid.simpleapi import *
+from testhelpers import (assertRaisesNothing, create_algorithm)
+
+class ReflectometryReductionOne2Test(unittest.TestCase):
+
+ def tearDown(self):
+ mtd.clear()
+
+ def test_execution_AveragePixelFit(self):
+ """
+ Check that the algorithm executes using background method AveragePixelFit
+ """
+ self._create_workspace_with_pixel_background('workspace_with_peak')
+ args = {'InputWorkspace' : 'workspace_with_peak',
+ 'ThetaIn' : 0.5,
+ 'I0MonitorIndex' : 1,
+ 'WavelengthMin' : 0,
+ 'WavelengthMax' : 5,
+ 'ProcessingInstructions' : '2',
+ 'SubtractBackground' : True,
+ 'BackgroundProcessingInstructions' : '1-3',
+ 'BackgroundCalculationMethod' : 'AveragePixelFit',
+ 'OutputWorkspace': 'output'}
+ output = self._assert_run_algorithm_succeeds(args)
+ history = ['ExtractSpectra', 'ReflectometryBackgroundSubtraction', 'GroupDetectors',
+ 'ConvertUnits', 'CropWorkspace', 'ConvertUnits']
+ self._check_history(output, history)
+ self._check_history_algorithm_properties(output, 1, 1,
+ {'ProcessingInstructions': '1-3',
+ 'BackgroundCalculationMethod': 'AveragePixelFit',
+ 'PeakRange': '2'})
+
+ def _assert_run_algorithm_succeeds(self, args):
+ """ Run the algorithm with the given args and check it succeeds """
+ alg = create_algorithm('ReflectometryReductionOne', **args)
+ assertRaisesNothing(self, alg.execute)
+ self.assertTrue(mtd.doesExist('output'))
+ return mtd['output']
+
+ def _create_workspace_with_pixel_background(self, name):
+ # Create a workspace with a background of 2 in the pixels adjacent to
+ # a peak of 5 in the 2nd index
+ empty = [0, 0, 0, 0]
+ background = [2, 2, 2, 2]
+ peak = [5, 5, 5, 5]
+ nspec = 5
+ ws = CreateSampleWorkspace(NumBanks=nspec, BankPixelWidth=1, XMin=1, XMax=5,
+ BinWidth=1, XUnit='TOF', WorkspaceType='Histogram',
+ NumMonitors=0, OutputWorkspace=name)
+ ws.setY(0, empty)
+ ws.setY(1, background)
+ ws.setY(2, peak)
+ ws.setY(3, background)
+ ws.setY(4, empty)
+
+ def _check_history(self, ws, expected, unroll = True):
+ """Return true if algorithm names listed in algorithmNames are found in the
+ workspace's history. If unroll is true, checks the child histories, otherwise
+ checks the top level history (the latter is required for sliced workspaces where
+ the child workspaces have lost their parent's history)
+ """
+ history = ws.getHistory()
+ if unroll:
+ reductionHistory = history.getAlgorithmHistory(history.size() - 1)
+ algHistories = reductionHistory.getChildHistories()
+ algNames = [alg.name() for alg in algHistories]
+ else:
+ algNames = [alg.name() for alg in history]
+ self.assertEqual(algNames, expected)
+
+ def _check_history_algorithm_properties(self, ws, toplevel_idx, child_idx, property_values):
+ parent_hist = ws.getHistory().getAlgorithmHistory(toplevel_idx)
+ child_hist = parent_hist.getChildHistories()[child_idx]
+ for prop, val in property_values.items():
+ self.assertEqual(child_hist.getPropertyValue(prop), val)
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/Framework/Algorithms/test/ReflectometryReductionOneAuto3Test.h b/Framework/Algorithms/test/ReflectometryReductionOneAuto3Test.h
index 6f2bd906fefd8e26b39f66b3927cb9b0e9d4b291..73e03c801f5ab8366bb0f3a32c15c9ca62cdc516 100644
--- a/Framework/Algorithms/test/ReflectometryReductionOneAuto3Test.h
+++ b/Framework/Algorithms/test/ReflectometryReductionOneAuto3Test.h
@@ -693,7 +693,7 @@ public:
TS_ASSERT(AnalysisDataService::Instance().doesExist("IvsQ_binned"));
TS_ASSERT(AnalysisDataService::Instance().doesExist("IvsQ"));
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("IvsLam"));
+ TS_ASSERT(AnalysisDataService::Instance().doesExist("IvsLam"));
AnalysisDataService::Instance().clear();
}
diff --git a/Framework/CurveFitting/CMakeLists.txt b/Framework/CurveFitting/CMakeLists.txt
index 2115d42c412e0cd67bfdcecf18dbaf28b87c4e10..4f1977181c64e9ee159cfd041d3ae76c28256768 100644
--- a/Framework/CurveFitting/CMakeLists.txt
+++ b/Framework/CurveFitting/CMakeLists.txt
@@ -20,6 +20,7 @@ set(SRC_FILES
src/Algorithms/PlotPeakByLogValueHelper.cpp
src/Algorithms/QENSFitSequential.cpp
src/Algorithms/QENSFitSimultaneous.cpp
+ src/Algorithms/QENSFitUtilities.cpp
src/Algorithms/RefinePowderInstrumentParameters.cpp
src/Algorithms/RefinePowderInstrumentParameters3.cpp
src/Algorithms/SplineBackground.cpp
@@ -185,6 +186,7 @@ set(INC_FILES
inc/MantidCurveFitting/Algorithms/PlotPeakByLogValueHelper.h
inc/MantidCurveFitting/Algorithms/QENSFitSequential.h
inc/MantidCurveFitting/Algorithms/QENSFitSimultaneous.h
+ inc/MantidCurveFitting/Algorithms/QENSFitUtilities.h
inc/MantidCurveFitting/Algorithms/RefinePowderInstrumentParameters.h
inc/MantidCurveFitting/Algorithms/RefinePowderInstrumentParameters3.h
inc/MantidCurveFitting/Algorithms/SplineBackground.h
diff --git a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitSequential.h b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitSequential.h
index 9b14cb0459158bfbf081e251696f4a22952d131a..e08b16b6328634bfeea491637e432c40f51f2aac 100644
--- a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitSequential.h
+++ b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitSequential.h
@@ -71,7 +71,7 @@ private:
std::vector<std::string> const &spectra,
std::string const &outputBaseName,
std::string const &endOfSuffix,
- std::vector<API::MatrixWorkspace_sptr> const &names);
+ std::vector<std::string> const &names);
void renameGroupWorkspace(std::string const ¤tName,
std::vector<std::string> const &spectra,
std::string const &outputBaseName,
diff --git a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitSimultaneous.h b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitSimultaneous.h
index d97c63bbe6a30beac86752ebd15ac1782b3b5d29..fd9954345d3547185efae2c2d67dedb93db7727b 100644
--- a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitSimultaneous.h
+++ b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitSimultaneous.h
@@ -65,6 +65,13 @@ private:
const std::string &outputWsName) const;
std::string getOutputBaseName() const;
+ std::vector<std::string> getWorkspaceNames() const;
+ std::vector<std::string> getWorkspaceIndices() const;
+ void renameWorkspaces(API::WorkspaceGroup_sptr outputGroup,
+ std::vector<std::string> const &spectra,
+ std::string const &outputBaseName,
+ std::string const &endOfSuffix,
+ std::vector<std::string> const &inputWorkspaceNames);
};
} // namespace Algorithms
diff --git a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitUtilities.h b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitUtilities.h
new file mode 100644
index 0000000000000000000000000000000000000000..aee11611a2073ec518bacd2a999413147f6e257e
--- /dev/null
+++ b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/QENSFitUtilities.h
@@ -0,0 +1,29 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2015 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+
+#ifndef MANTID_ALGORITHMS_QENSFITUTILITIES_H_
+#define MANTID_ALGORITHMS_QENSFITUTILITIES_H_
+
+#include "MantidAPI/Algorithm.h"
+#include "MantidAPI/WorkspaceGroup.h"
+
+#include <functional>
+
+namespace Mantid {
+namespace API {
+
+void renameWorkspacesInQENSFit(
+ Algorithm *qensFit, IAlgorithm_sptr renameAlgorithm,
+ WorkspaceGroup_sptr outputGroup, std::string const &outputBaseName,
+ std::string const &groupSuffix,
+ std::function<std::string(std::size_t)> const &getNameSuffix);
+
+bool containsMultipleData(const std::vector<MatrixWorkspace_sptr> &workspaces);
+
+} // namespace API
+} // namespace Mantid
+#endif
\ No newline at end of file
diff --git a/Framework/CurveFitting/inc/MantidCurveFitting/IFittingAlgorithm.h b/Framework/CurveFitting/inc/MantidCurveFitting/IFittingAlgorithm.h
index d9626bf134677cf8eadd670fee3a9e8190ec7db8..ad9081c848e9b0ad6250338313d5435a55d5e4c9 100644
--- a/Framework/CurveFitting/inc/MantidCurveFitting/IFittingAlgorithm.h
+++ b/Framework/CurveFitting/inc/MantidCurveFitting/IFittingAlgorithm.h
@@ -69,6 +69,7 @@ protected:
/// Pointer to a domain creator
boost::shared_ptr<API::IDomainCreator> m_domainCreator;
std::vector<std::string> m_workspacePropertyNames;
+ std::vector<std::string> m_workspaceIndexPropertyNames;
friend class API::IDomainCreator;
};
diff --git a/Framework/CurveFitting/src/Algorithms/QENSFitSequential.cpp b/Framework/CurveFitting/src/Algorithms/QENSFitSequential.cpp
index fcf4db7237bbbe53c82a5d1c317b871949bdeabf..1c624eee9c5c1bdc32cac4b310fe9a716a1d28a0 100644
--- a/Framework/CurveFitting/src/Algorithms/QENSFitSequential.cpp
+++ b/Framework/CurveFitting/src/Algorithms/QENSFitSequential.cpp
@@ -155,17 +155,25 @@ std::string constructInputString(MatrixWorkspace_sptr workspace, int specMin,
return input.str();
}
+std::vector<std::string> extractWorkspaceNames(const std::string &input) {
+ std::vector<std::string> v;
+ boost::regex reg("([^,;]+),");
+ std::for_each(
+ boost::sregex_token_iterator(input.begin(), input.end(), reg, 1),
+ boost::sregex_token_iterator(),
+ [&v](const std::string &name) { v.emplace_back(name); });
+ return v;
+}
+
std::vector<MatrixWorkspace_sptr> extractWorkspaces(const std::string &input) {
+ const auto workspaceNames = extractWorkspaceNames(input);
+
std::vector<MatrixWorkspace_sptr> workspaces;
- auto extractWorkspace = [&](const std::string &name) {
- workspaces.emplace_back(getADSMatrixWorkspace(name));
- };
+ for (const auto &wsName : workspaceNames) {
+ workspaces.emplace_back(getADSMatrixWorkspace(wsName));
+ }
- boost::regex reg("([^,;]+),");
- std::for_each(
- boost::sregex_token_iterator(input.begin(), input.end(), reg, 1),
- boost::sregex_token_iterator(), extractWorkspace);
return workspaces;
}
@@ -532,11 +540,13 @@ void QENSFitSequential::exec() {
AnalysisDataService::Instance().addOrReplace(
getPropertyValue("OutputWorkspace"), resultWs);
- if (containsMultipleData(workspaces))
+ if (containsMultipleData(workspaces)) {
+ const auto inputString = getPropertyValue("Input");
renameWorkspaces(groupWs, spectra, outputBaseName, "_Workspace",
- inputWorkspaces);
- else
+ extractWorkspaceNames(inputString));
+ } else {
renameWorkspaces(groupWs, spectra, outputBaseName, "_Workspace");
+ }
copyLogs(resultWs, workspaces);
@@ -691,10 +701,12 @@ QENSFitSequential::processParameterTable(ITableWorkspace_sptr parameterTable) {
void QENSFitSequential::renameWorkspaces(
WorkspaceGroup_sptr outputGroup, std::vector<std::string> const &spectra,
std::string const &outputBaseName, std::string const &endOfSuffix,
- std::vector<MatrixWorkspace_sptr> const &inputWorkspaces) {
+ std::vector<std::string> const &inputWorkspaceNames) {
auto rename = createChildAlgorithm("RenameWorkspace", -1.0, -1.0, false);
const auto getNameSuffix = [&](std::size_t i) {
- return inputWorkspaces[i]->getName() + "_" + spectra[i] + endOfSuffix;
+ std::string workspaceName =
+ inputWorkspaceNames[i] + "_" + spectra[i] + endOfSuffix;
+ return workspaceName;
};
return renameWorkspacesInQENSFit(this, rename, outputGroup, outputBaseName,
endOfSuffix + "s", getNameSuffix);
@@ -763,8 +775,10 @@ std::string QENSFitSequential::getInputString(
std::vector<MatrixWorkspace_sptr> QENSFitSequential::getWorkspaces() const {
const auto inputString = getPropertyValue("Input");
- if (!inputString.empty())
- return extractWorkspaces(inputString);
+ if (!inputString.empty()) {
+ auto workspaceList = extractWorkspaces(inputString);
+ return workspaceList;
+ }
// The static_cast should not be necessary but it is required to avoid a
// "internal compiler error: segmentation fault" when compiling with gcc
// and std=c++1z
diff --git a/Framework/CurveFitting/src/Algorithms/QENSFitSimultaneous.cpp b/Framework/CurveFitting/src/Algorithms/QENSFitSimultaneous.cpp
index 38a21c703e1196c0caa76824aca6d565b6d49327..dc3383093193689705a5b9c55c37f9b4f44b5655 100644
--- a/Framework/CurveFitting/src/Algorithms/QENSFitSimultaneous.cpp
+++ b/Framework/CurveFitting/src/Algorithms/QENSFitSimultaneous.cpp
@@ -5,6 +5,7 @@
// & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidCurveFitting/Algorithms/QENSFitSimultaneous.h"
+#include "MantidCurveFitting/Algorithms/QENSFitUtilities.h"
#include "MantidCurveFitting/CostFunctions/CostFuncFitting.h"
#include "MantidAPI/AlgorithmManager.h"
@@ -436,6 +437,12 @@ void QENSFitSimultaneous::execConcrete() {
const auto groupWs = makeGroup(fitResult.second);
const auto resultWs = processIndirectFitParameters(
parameterWs, createDatasetGrouping(workspaces));
+
+ if (containsMultipleData(workspaces)) {
+ renameWorkspaces(groupWs, getWorkspaceIndices(), outputBaseName,
+ "_Workspace", getWorkspaceNames());
+ }
+
copyLogs(resultWs, workspaces);
const bool doExtractMembers = getProperty("ExtractMembers");
@@ -606,6 +613,26 @@ std::vector<MatrixWorkspace_sptr> QENSFitSimultaneous::getWorkspaces() const {
return workspaces;
}
+std::vector<std::string> QENSFitSimultaneous::getWorkspaceIndices() const {
+ std::vector<std::string> workspaceIndices;
+ workspaceIndices.reserve(m_workspaceIndexPropertyNames.size());
+ for (const auto &propertName : m_workspaceIndexPropertyNames) {
+ std::string workspaceIndex = getPropertyValue(propertName);
+ workspaceIndices.emplace_back(workspaceIndex);
+ }
+ return workspaceIndices;
+}
+
+std::vector<std::string> QENSFitSimultaneous::getWorkspaceNames() const {
+ std::vector<std::string> workspaceNames;
+ workspaceNames.reserve(m_workspacePropertyNames.size());
+ for (const auto &propertName : m_workspacePropertyNames) {
+ std::string workspaceName = getPropertyValue(propertName);
+ workspaceNames.emplace_back(workspaceName);
+ }
+ return workspaceNames;
+}
+
std::vector<MatrixWorkspace_sptr> QENSFitSimultaneous::convertInputToElasticQ(
const std::vector<MatrixWorkspace_sptr> &workspaces) const {
return convertToElasticQ(workspaces, throwIfElasticQConversionFails());
@@ -669,6 +696,21 @@ ITableWorkspace_sptr QENSFitSimultaneous::processParameterTable(
return parameterTable;
}
+void QENSFitSimultaneous::renameWorkspaces(
+ API::WorkspaceGroup_sptr outputGroup,
+ std::vector<std::string> const &spectra, std::string const &outputBaseName,
+ std::string const &endOfSuffix,
+ std::vector<std::string> const &inputWorkspaceNames) {
+ auto rename = createChildAlgorithm("RenameWorkspace", -1.0, -1.0, false);
+ const auto getNameSuffix = [&](std::size_t i) {
+ std::string workspaceName =
+ inputWorkspaceNames[i] + "_" + spectra[i] + endOfSuffix;
+ return workspaceName;
+ };
+ return renameWorkspacesInQENSFit(this, rename, outputGroup, outputBaseName,
+ endOfSuffix + "s", getNameSuffix);
+}
+
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid
diff --git a/Framework/CurveFitting/src/Algorithms/QENSFitUtilities.cpp b/Framework/CurveFitting/src/Algorithms/QENSFitUtilities.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..c2917c2a1877837647c99376867b84ccaf9fb50f
--- /dev/null
+++ b/Framework/CurveFitting/src/Algorithms/QENSFitUtilities.cpp
@@ -0,0 +1,59 @@
+#include "MantidCurveFitting/Algorithms/QENSFitUtilities.h"
+#include <unordered_map>
+namespace Mantid {
+namespace API {
+
+void renameWorkspacesWith(
+ WorkspaceGroup_sptr groupWorkspace,
+ std::function<std::string(std::size_t)> const &getName,
+ std::function<void(Workspace_sptr, const std::string &)> const &renamer) {
+ std::unordered_map<std::string, std::size_t> nameCount;
+ for (auto i = 0u; i < groupWorkspace->size(); ++i) {
+ const auto name = getName(i);
+ auto count = nameCount.find(name);
+
+ if (count == nameCount.end()) {
+ renamer(groupWorkspace->getItem(i), name);
+ nameCount[name] = 1;
+ } else
+ renamer(groupWorkspace->getItem(i),
+ name + "(" + std::to_string(++count->second) + ")");
+ }
+}
+
+void renameWorkspace(IAlgorithm_sptr renamer, Workspace_sptr workspace,
+ const std::string &newName) {
+ renamer->setProperty("InputWorkspace", workspace);
+ renamer->setProperty("OutputWorkspace", newName);
+ renamer->executeAsChildAlg();
+}
+
+bool containsMultipleData(const std::vector<MatrixWorkspace_sptr> &workspaces) {
+ const auto &first = workspaces.front();
+ return std::any_of(
+ workspaces.cbegin(), workspaces.cend(),
+ [&first](const auto &workspace) { return workspace != first; });
+}
+
+void renameWorkspacesInQENSFit(
+ Algorithm *qensFit, IAlgorithm_sptr renameAlgorithm,
+ WorkspaceGroup_sptr outputGroup, std::string const &outputBaseName,
+ std::string const &,
+ std::function<std::string(std::size_t)> const &getNameSuffix) {
+ Progress renamerProg(qensFit, 0.98, 1.0, outputGroup->size() + 1);
+ renamerProg.report("Renaming group workspaces...");
+
+ auto getName = [&](std::size_t i) {
+ std::string name = outputBaseName + "_" + getNameSuffix(i);
+ return name;
+ };
+
+ auto renamer = [&](Workspace_sptr workspace, const std::string &name) {
+ renameWorkspace(renameAlgorithm, workspace, name);
+ renamerProg.report("Renamed workspace in group.");
+ };
+ renameWorkspacesWith(outputGroup, getName, renamer);
+}
+
+} // namespace API
+} // namespace Mantid
\ No newline at end of file
diff --git a/Framework/CurveFitting/src/Functions/CrystalFieldSpectrum.cpp b/Framework/CurveFitting/src/Functions/CrystalFieldSpectrum.cpp
index 35ff744cd66263e943c799954f80059b52431ea4..231f70dbc4d11e1f4081d0aee03849ebb12a5f2d 100644
--- a/Framework/CurveFitting/src/Functions/CrystalFieldSpectrum.cpp
+++ b/Framework/CurveFitting/src/Functions/CrystalFieldSpectrum.cpp
@@ -127,26 +127,38 @@ std::string CrystalFieldSpectrum::writeToString(
}
}
- // Print parameters of the important peaks only
const auto &spectrum = dynamic_cast<const CompositeFunction &>(*m_target);
- for (size_t ip = 0; ip < m_nPeaks; ++ip) {
+ for (size_t ip = 0; ip < spectrum.nFunctions(); ++ip) {
const auto &peak = dynamic_cast<IPeakFunction &>(*spectrum.getFunction(ip));
- // Print peak's atributes
- const auto attrNames = peak.getAttributeNames();
- for (const auto &attName : attrNames) {
- const std::string attValue = peak.getAttribute(attName).value();
- if (!attValue.empty() && attValue != "\"\"") {
- ostr << ",f" << ip << "." << attName << '=' << attValue;
+ // Print parameters of the important peaks only
+ if (ip < m_nPeaks) {
+ // Print peak's atributes
+ const auto attrNames = peak.getAttributeNames();
+ for (const auto &attName : attrNames) {
+ const std::string attValue = peak.getAttribute(attName).value();
+ if (!attValue.empty() && attValue != "\"\"") {
+ ostr << ",f" << ip << "." << attName << '=' << attValue;
+ }
}
}
- // Print peak's parameters
+ // Print important peak's parameters
for (size_t i = 0; i < peak.nParams(); i++) {
const ParameterTie *tie = peak.getTie(i);
- if (!tie || !tie->isDefault()) {
- ostr << ",f" << ip << "." << peak.parameterName(i) << '='
- << peak.getParameter(i);
+ std::ostringstream paramString;
+ paramString << "f" << ip << "." << peak.parameterName(i) << '='
+ << peak.getParameter(i);
+ if (ip < m_nPeaks && (!tie || !tie->isDefault())) {
+ ostr << ',' << paramString.str();
+ }
+ // Add fixed ties for all peaks
+ if (peak.isFixed(i) && !peak.isFixedByDefault(i)) {
+ ties.emplace_back(paramString.str());
}
}
+ // collect non-default ties for peaks
+ const auto peakTies = peak.writeTies();
+ if (!peakTies.empty())
+ ties.emplace_back(peakTies);
} // for peaks
// collect non-default constraints
diff --git a/Framework/CurveFitting/src/IFittingAlgorithm.cpp b/Framework/CurveFitting/src/IFittingAlgorithm.cpp
index b4f83551fad630e9d8092f161aac631349fa42ad..56904cc972ea214fa4db08912210e1c6afeb62c3 100644
--- a/Framework/CurveFitting/src/IFittingAlgorithm.cpp
+++ b/Framework/CurveFitting/src/IFittingAlgorithm.cpp
@@ -169,10 +169,15 @@ void IFittingAlgorithm::setFunction() {
size_t ndom = m_function->getNumberDomains();
if (ndom > 1) {
m_workspacePropertyNames.resize(ndom);
+ m_workspaceIndexPropertyNames.resize(ndom);
m_workspacePropertyNames[0] = "InputWorkspace";
+ m_workspaceIndexPropertyNames[0] = "WorkspaceIndex";
for (size_t i = 1; i < ndom; ++i) {
std::string workspacePropertyName = "InputWorkspace_" + std::to_string(i);
m_workspacePropertyNames[i] = workspacePropertyName;
+ std::string workspaceIndexPropertyName =
+ "WorkspaceIndex_" + std::to_string(i);
+ m_workspaceIndexPropertyNames[i] = workspaceIndexPropertyName;
if (!existsProperty(workspacePropertyName)) {
declareProperty(
std::make_unique<API::WorkspaceProperty<API::Workspace>>(
@@ -182,6 +187,7 @@ void IFittingAlgorithm::setFunction() {
}
} else {
m_workspacePropertyNames.resize(1, "InputWorkspace");
+ m_workspaceIndexPropertyNames.resize(1, "WorkspaceIndex");
}
}
@@ -288,6 +294,7 @@ void IFittingAlgorithm::addWorkspaces() {
creator->declareDatasetProperties("", true);
m_domainCreator.reset(creator.release());
m_workspacePropertyNames.clear();
+ m_workspaceIndexPropertyNames.clear();
}
}
diff --git a/Framework/DataHandling/CMakeLists.txt b/Framework/DataHandling/CMakeLists.txt
index 0c25ed6097334899a9a49e89745c56453811095c..0de48b0bcaba3811e81fabd30699de4295974dfd 100644
--- a/Framework/DataHandling/CMakeLists.txt
+++ b/Framework/DataHandling/CMakeLists.txt
@@ -187,6 +187,7 @@ set(SRC_FILES
src/SaveReflCustomAscii.cpp
src/SaveReflThreeColumnAscii.cpp
src/SaveReflectometryAscii.cpp
+ src/SaveRMCProfile.cpp
src/SaveSESANS.cpp
src/SaveSPE.cpp
src/SaveSampleEnvironmentAndShape.cpp
@@ -390,6 +391,7 @@ set(INC_FILES
inc/MantidDataHandling/SaveReflCustomAscii.h
inc/MantidDataHandling/SaveReflThreeColumnAscii.h
inc/MantidDataHandling/SaveReflectometryAscii.h
+ inc/MantidDataHandling/SaveRMCProfile.h
inc/MantidDataHandling/SaveSESANS.h
inc/MantidDataHandling/SaveSPE.h
inc/MantidDataHandling/SaveSampleEnvironmentAndShape.h
@@ -581,6 +583,7 @@ set(TEST_FILES
SaveReflCustomAsciiTest.h
SaveReflThreeColumnAsciiTest.h
SaveReflectometryAsciiTest.h
+ SaveRMCProfileTest.h
SaveSESANSTest.h
SaveSPETest.h
SaveSampleEnvironmentAndShapeTest.h
diff --git a/Framework/DataHandling/inc/MantidDataHandling/LoadPSIMuonBin.h b/Framework/DataHandling/inc/MantidDataHandling/LoadPSIMuonBin.h
index e0f5ac3cb37218cab7daa8729aeeea8611a82e95..129d1e91ca1196e9ba4153c1cfef6516b46ffa87 100644
--- a/Framework/DataHandling/inc/MantidDataHandling/LoadPSIMuonBin.h
+++ b/Framework/DataHandling/inc/MantidDataHandling/LoadPSIMuonBin.h
@@ -86,6 +86,7 @@ private:
void readInHeader(Mantid::Kernel::BinaryStreamReader &streamReader);
void readInHistograms(Mantid::Kernel::BinaryStreamReader &streamReader);
void generateUnknownAxis();
+ void makeDeadTimeTable(const size_t &numSpec);
// Temperature file processing
void readInTemperatureFile(DataObjects::Workspace2D_sptr &ws);
diff --git a/Framework/DataHandling/inc/MantidDataHandling/SavePDFGui.h b/Framework/DataHandling/inc/MantidDataHandling/SavePDFGui.h
index 342b4caecf3543d2fcf779972205459a7e25af71..a13dc4db268b74abe23f2bbd9e8f7fb3da4af7d6 100644
--- a/Framework/DataHandling/inc/MantidDataHandling/SavePDFGui.h
+++ b/Framework/DataHandling/inc/MantidDataHandling/SavePDFGui.h
@@ -13,8 +13,15 @@
namespace Mantid {
namespace DataHandling {
-/** SavePDFGui : TODO: DESCRIPTION
- */
+/** SavePDFGui : Saves a workspace containing a pair distrebution function in a
+format readable by the PDFgui package.
+
+Required Properties:
+<UL>
+<LI> InputWorkspace - An input workspace with units of Atomic Distance </LI>
+<LI> Filename - The filename to use for the saved data </LI>
+</UL>
+*/
class DLLExport SavePDFGui : public API::Algorithm {
public:
const std::string name() const override;
@@ -29,6 +36,9 @@ public:
private:
void init() override;
void exec() override;
+ void writeMetaData(std::ofstream &out,
+ API::MatrixWorkspace_const_sptr inputWS);
+ void writeWSData(std::ofstream &out, API::MatrixWorkspace_const_sptr inputWS);
};
} // namespace DataHandling
diff --git a/Framework/DataHandling/inc/MantidDataHandling/SaveRMCProfile.h b/Framework/DataHandling/inc/MantidDataHandling/SaveRMCProfile.h
new file mode 100644
index 0000000000000000000000000000000000000000..e27ba506f3d0784ce493c8d828300ccf9fb196ae
--- /dev/null
+++ b/Framework/DataHandling/inc/MantidDataHandling/SaveRMCProfile.h
@@ -0,0 +1,47 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef MANTID_DATAHANDLING_SAVERMCPROFILE_H_
+#define MANTID_DATAHANDLING_SAVERMCPROFILE_H_
+
+#include "MantidAPI/Algorithm.h"
+#include "MantidKernel/System.h"
+
+namespace Mantid {
+namespace DataHandling {
+
+/** SaveRMCProfile : Saves a workspace containing a spectral density in a format
+readable by the RMCProfile package.
+
+Required Properties:
+<UL>
+<LI> InputWorkspace - An input workspace with units of Q </LI>
+<LI> Filename - The filename to use for the saved data </LI>
+</UL>
+ */
+class DLLExport SaveRMCProfile : public API::Algorithm {
+public:
+ const std::string name() const override;
+ int version() const override;
+ const std::vector<std::string> seeAlso() const override {
+ return {"SaveRMCProfile"};
+ }
+ const std::string category() const override;
+ const std::string summary() const override;
+ std::map<std::string, std::string> validateInputs() override;
+
+private:
+ void init() override;
+ void exec() override;
+ void writeMetaData(std::ofstream &out,
+ API::MatrixWorkspace_const_sptr inputWS);
+ void writeWSData(std::ofstream &out, API::MatrixWorkspace_const_sptr inputWS);
+};
+
+} // namespace DataHandling
+} // namespace Mantid
+
+#endif /* MANTID_DATAHANDLING_SAVERMCPROFILE_H_ */
diff --git a/Framework/DataHandling/src/LoadPSIMuonBin.cpp b/Framework/DataHandling/src/LoadPSIMuonBin.cpp
index d066ae96b9b0ec75edebdb878936ee94bf85de0c..3df3202a082722c84d5e40bfa38bc11d1d9dab54 100644
--- a/Framework/DataHandling/src/LoadPSIMuonBin.cpp
+++ b/Framework/DataHandling/src/LoadPSIMuonBin.cpp
@@ -10,6 +10,9 @@
#include "MantidAPI/FileProperty.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/RegisterFileLoader.h"
+#include "MantidAPI/TableRow.h"
+#include "MantidAPI/WorkspaceFactory.h"
+#include "MantidDataObjects/TableWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidDataObjects/WorkspaceCreation.h"
#include "MantidHistogramData/Histogram.h"
@@ -107,10 +110,12 @@ void LoadPSIMuonBin::init() {
declareProperty("TimeZero", 0.0, "The TimeZero of the OutputWorkspace",
Kernel::Direction::Output);
- declareProperty("DataDeadTimeTable", 0,
- "This property should not be set and is present to work with "
- "the Muon GUI preprocessor.",
- Kernel::Direction::Output);
+ declareProperty(
+ std::make_unique<Mantid::API::WorkspaceProperty<Mantid::API::Workspace>>(
+ "DeadTimeTable", "", Mantid::Kernel::Direction::Output,
+ Mantid::API::PropertyMode::Optional),
+ "This property should only be set in the GUI and is present to work with "
+ "the Muon GUI preprocessor.");
declareProperty("MainFieldDirection", 0,
"The field direction of the magnetic field on the instrument",
@@ -166,13 +171,12 @@ void LoadPSIMuonBin::exec() {
// Set up for the Muon PreProcessor
setProperty("OutputWorkspace", outputWorkspace);
+ // create empty dead time table
+ makeDeadTimeTable(m_histograms.size());
+
auto largestBinValue =
outputWorkspace->x(0)[outputWorkspace->x(0).size() - 1];
- auto firstGoodDataSpecIndex = static_cast<int>(
- *std::max_element(m_header.firstGood, m_header.firstGood + 16));
- setProperty("FirstGoodData", outputWorkspace->x(0)[firstGoodDataSpecIndex]);
-
// Since the arrray is all 0s before adding them this can't get min
// element so just get first element
auto lastGoodDataSpecIndex = static_cast<int>(m_header.lastGood[0]);
@@ -189,14 +193,46 @@ void LoadPSIMuonBin::exec() {
// If timeZero is bigger than the largest bin assume it refers to a bin's
// value
+ double absTimeZero = timeZero;
if (timeZero > largestBinValue) {
- setProperty("TimeZero",
- outputWorkspace->x(0)[static_cast<int>(std::floor(timeZero))]);
- } else {
- setProperty("TimeZero", timeZero);
+ absTimeZero = outputWorkspace->x(0)[static_cast<int>(std::floor(timeZero))];
+ }
+ setProperty("TimeZero", absTimeZero);
+
+ auto firstGoodDataSpecIndex = static_cast<int>(
+ *std::max_element(m_header.firstGood, m_header.firstGood + 16));
+
+ setProperty("FirstGoodData", outputWorkspace->x(0)[firstGoodDataSpecIndex]);
+
+ // Time zero is when the pulse starts.
+ // The pulse should be at t=0 to be like ISIS data
+ // manually offset the data
+ for (auto specNum = 0u; specNum < m_histograms.size(); ++specNum) {
+ auto &xData = outputWorkspace->mutableX(specNum);
+ for (auto &xValue : xData) {
+ xValue -= absTimeZero;
+ }
}
}
+void LoadPSIMuonBin::makeDeadTimeTable(const size_t &numSpec) {
+ if (getPropertyValue("DeadTimeTable").empty())
+ return;
+ Mantid::DataObjects::TableWorkspace_sptr deadTimeTable =
+ boost::dynamic_pointer_cast<Mantid::DataObjects::TableWorkspace>(
+ Mantid::API::WorkspaceFactory::Instance().createTable(
+ "TableWorkspace"));
+ assert(deadTimeTable);
+ deadTimeTable->addColumn("int", "spectrum");
+ deadTimeTable->addColumn("double", "dead-time");
+
+ for (size_t i = 0; i < numSpec; i++) {
+ Mantid::API::TableRow row = deadTimeTable->appendRow();
+ row << static_cast<int>(i) + 1 << 0.0;
+ }
+ setProperty("DeadTimeTable", deadTimeTable);
+}
+
std::string LoadPSIMuonBin::getFormattedDateTime(std::string date,
std::string time) {
std::string year;
@@ -481,8 +517,8 @@ void LoadPSIMuonBin::assignOutputWorkspaceParticulars(
g_log.warning("The date in the .bin file was invalid");
}
- addToSampleLog("run_end", startDate, outputWorkspace);
- addToSampleLog("run_start", endDate, outputWorkspace);
+ addToSampleLog("run_end", endDate, outputWorkspace);
+ addToSampleLog("run_start", startDate, outputWorkspace);
// Assume unit is at the end of the temperature
boost::trim_right(m_header.temp);
@@ -552,8 +588,16 @@ void LoadPSIMuonBin::assignOutputWorkspaceParticulars(
for (auto i = 0u; i < sizeOfLabels; ++i) {
if (m_header.labelsOfHistograms[i] == "")
break;
- addToSampleLog("Label Spectra " + std::to_string(i),
- m_header.labelsOfHistograms[i], outputWorkspace);
+ std::string name = m_header.labelsOfHistograms[i];
+ // if empty name is present (i.e. just empty space)
+ // replace with default name:
+ // group_specNum
+ const bool isSpace = name.find_first_not_of(" ") == std::string::npos;
+ std::string label = isSpace ? "group_" + std::to_string(i + 1)
+ : m_header.labelsOfHistograms[i];
+
+ addToSampleLog("Label Spectra " + std::to_string(i), std::move(label),
+ outputWorkspace);
}
addToSampleLog("Orientation", m_header.orientation, outputWorkspace);
diff --git a/Framework/DataHandling/src/SavePDFGui.cpp b/Framework/DataHandling/src/SavePDFGui.cpp
index fc400577a5a0feb4457979ba9512a5aecb8474ef..4c6d0c34c7866388a3a19748f1d8052fea8a6b12 100644
--- a/Framework/DataHandling/src/SavePDFGui.cpp
+++ b/Framework/DataHandling/src/SavePDFGui.cpp
@@ -43,7 +43,7 @@ const std::string SavePDFGui::summary() const {
void SavePDFGui::init() {
declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "",
Direction::Input),
- "An input workspace.");
+ "An input workspace with units of Atomic Distance.");
declareProperty(std::make_unique<API::FileProperty>(
"Filename", "", API::FileProperty::Save, ".gr"),
"The filename to use for the saved data");
@@ -82,6 +82,17 @@ void SavePDFGui::exec() {
// --------- write the header in the style of
//#Comment: neutron, Qmin=0.5, Qmax=31.42, Qdamp=0.017659, Qbroad= 0.0191822,
// Temperature = 300
+ writeMetaData(out, inputWS);
+
+ // --------- write the data
+ writeWSData(out, inputWS);
+
+ // --------- close the file
+ out.close();
+}
+
+void SavePDFGui::writeMetaData(std::ofstream &out,
+ API::MatrixWorkspace_const_sptr inputWS) {
out << "#Comment: neutron";
auto run = inputWS->run();
if (run.hasProperty("Qmin")) {
@@ -106,22 +117,20 @@ void SavePDFGui::exec() {
// out << "#P0 -22.03808 1.10131 2556.26392 0.03422 1.50 0.5985\n";
// // TODO
out << "#L r G(r) dr dG(r)\n";
+}
- // --------- write the data
- const auto &x = inputWS->x(0);
+void SavePDFGui::writeWSData(std::ofstream &out,
+ API::MatrixWorkspace_const_sptr inputWS) {
+ const auto &x = inputWS->points(0);
const auto &y = inputWS->y(0);
const auto &dy = inputWS->e(0);
HistogramData::HistogramDx dx(y.size(), 0.0);
if (inputWS->sharedDx(0))
dx = inputWS->dx(0);
- const size_t length = x.size();
- for (size_t i = 0; i < length; ++i) {
+ for (size_t i = 0; i < x.size(); ++i) {
out << " " << x[i] << " " << y[i] << " " << dx[i] << " " << dy[i]
<< "\n";
}
-
- // --------- close the file
- out.close();
}
} // namespace DataHandling
diff --git a/Framework/DataHandling/src/SaveRMCProfile.cpp b/Framework/DataHandling/src/SaveRMCProfile.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..ec078d36ba62ad9d50bf05e9986d0db444014a86
--- /dev/null
+++ b/Framework/DataHandling/src/SaveRMCProfile.cpp
@@ -0,0 +1,120 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "MantidDataHandling/SaveRMCProfile.h"
+
+#include "MantidAPI/Axis.h"
+#include "MantidAPI/FileProperty.h"
+#include "MantidAPI/MatrixWorkspace.h"
+#include "MantidAPI/Run.h"
+#include "MantidKernel/ListValidator.h"
+#include "MantidKernel/MantidVersion.h"
+#include "MantidKernel/Unit.h"
+
+#include <fstream>
+
+namespace Mantid {
+namespace DataHandling {
+
+using Mantid::API::WorkspaceProperty;
+using Mantid::Kernel::Direction;
+
+// Register the algorithm into the AlgorithmFactory
+DECLARE_ALGORITHM(SaveRMCProfile)
+
+/// Algorithm's name for identification. @see Algorithm::name
+const std::string SaveRMCProfile::name() const { return "SaveRMCProfile"; }
+
+/// Algorithm's version for identification. @see Algorithm::version
+int SaveRMCProfile::version() const { return 1; }
+
+/// Algorithm's category for identification. @see Algorithm::category
+const std::string SaveRMCProfile::category() const {
+ return "DataHandling\\Text";
+}
+
+/// Algorithm's summary for use in the GUI and help. @see Algorithm::summary
+const std::string SaveRMCProfile::summary() const {
+ return "Save files readable by RMCProfile";
+}
+
+/** Initialize the algorithm's properties.
+ */
+void SaveRMCProfile::init() {
+ declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "",
+ Direction::Input),
+ "An input workspace to be saved.");
+
+ declareProperty("InputType", "",
+ "To identify what input function is being used.");
+
+ declareProperty("Title", "", "The title line for the output file.");
+
+ declareProperty(std::make_unique<API::FileProperty>(
+ "Filename", "", API::FileProperty::Save, ".fq"),
+ "The filename to use for the saved data");
+}
+
+/// @copydoc Algorithm::validateInputs
+std::map<std::string, std::string> SaveRMCProfile::validateInputs() {
+ std::map<std::string, std::string> result;
+
+ // check for null pointers - this is to protect against workspace groups
+ API::MatrixWorkspace_const_sptr inputWS = getProperty("InputWorkspace");
+ if (!inputWS) {
+ result["InputWorkspace"] = "Workspace not found";
+ }
+
+ const auto nHist = static_cast<int>(inputWS->getNumberHistograms());
+ if (nHist != 1) {
+ result["InputWorkspace"] = "Workspace must contain only one spectrum";
+ }
+
+ return result;
+}
+
+/** Execute the algorithm.
+ */
+void SaveRMCProfile::exec() {
+ API::MatrixWorkspace_const_sptr inputWS = getProperty("InputWorkspace");
+ const std::string filename = getProperty("Filename");
+
+ // --------- open the file
+ std::ofstream out;
+ out.open(filename.c_str(), std::ios_base::out);
+
+ // --------- write the header in the style of required metadata
+ writeMetaData(out, inputWS);
+
+ // --------- write the data
+ writeWSData(out, inputWS);
+
+ // --------- close the file
+ out.close();
+}
+
+void SaveRMCProfile::writeMetaData(std::ofstream &out,
+ API::MatrixWorkspace_const_sptr inputWS) {
+ const auto &y = inputWS->y(0);
+ const std::string title = getProperty("Title");
+ const std::string inputType = getProperty("InputType");
+ out << y.size() << std::endl;
+ out << "rmc " << inputType << " # " << title << std::endl;
+ std::cout << y.size() << std::endl;
+ std::cout << "rmc " << inputType << " # " << title << std::endl;
+}
+
+void SaveRMCProfile::writeWSData(std::ofstream &out,
+ API::MatrixWorkspace_const_sptr inputWS) {
+ const auto &x = inputWS->points(0);
+ const auto &y = inputWS->y(0);
+ for (size_t i = 0; i < x.size(); ++i) {
+ out << " " << x[i] << " " << y[i] << "\n";
+ }
+}
+
+} // namespace DataHandling
+} // namespace Mantid
diff --git a/Framework/DataHandling/test/LoadPSIMuonBinTest.h b/Framework/DataHandling/test/LoadPSIMuonBinTest.h
index 31da139441d9add810cb70a714407fefded13d52..ad2e4ab4c4c6479ceeb486f8fc61690757a7849b 100644
--- a/Framework/DataHandling/test/LoadPSIMuonBinTest.h
+++ b/Framework/DataHandling/test/LoadPSIMuonBinTest.h
@@ -93,8 +93,8 @@ public:
TS_ASSERT_EQUALS(ws->y(0).size(), 10240);
TS_ASSERT_EQUALS(ws->e(0).size(), 10240);
- TS_ASSERT_EQUALS(ws->x(0)[0], 0);
- TS_ASSERT_EQUALS(ws->x(0)[10240], 10);
+ TS_ASSERT_DELTA(ws->x(0)[0], -0.160, 0.001);
+ TS_ASSERT_DELTA(ws->x(0)[10240], 9.84, 0.001);
TS_ASSERT_EQUALS(ws->y(0)[0], 24);
TS_ASSERT_EQUALS(ws->y(0)[10239], 44);
TS_ASSERT_EQUALS(ws->e(0)[0], std::sqrt(ws->y(0)[0]));
diff --git a/Framework/DataHandling/test/SaveRMCProfileTest.h b/Framework/DataHandling/test/SaveRMCProfileTest.h
new file mode 100644
index 0000000000000000000000000000000000000000..ed3643e876040ff29308d7bf615dab7933af9213
--- /dev/null
+++ b/Framework/DataHandling/test/SaveRMCProfileTest.h
@@ -0,0 +1,140 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef MANTID_DATAHANDLING_SAVERMCPROFILETEST_H_
+#define MANTID_DATAHANDLING_SAVERMCPROFILETEST_H_
+
+#include <Poco/File.h>
+#include <cxxtest/TestSuite.h>
+#include <fstream>
+
+#include "MantidAPI/AlgorithmManager.h"
+#include "MantidAPI/AnalysisDataService.h"
+#include "MantidDataHandling/LoadNexusProcessed.h"
+#include "MantidDataHandling/SaveRMCProfile.h"
+
+using Mantid::DataHandling::LoadNexusProcessed;
+using Mantid::DataHandling::SaveRMCProfile;
+using namespace Mantid::API;
+
+class SaveRMCProfileTest : public CxxTest::TestSuite {
+public:
+ // This pair of boilerplate methods prevent the suite being created statically
+ // This means the constructor isn't called when running other tests
+ static SaveRMCProfileTest *createSuite() { return new SaveRMCProfileTest(); }
+ static void destroySuite(SaveRMCProfileTest *suite) { delete suite; }
+
+ void test_Init() {
+ SaveRMCProfile alg;
+ TS_ASSERT_THROWS_NOTHING(alg.initialize())
+ TS_ASSERT(alg.isInitialized())
+ }
+
+ size_t read(std::istream &is, std::vector<char> &buff) {
+ is.read(&buff[0], buff.size());
+ return is.gcount();
+ }
+
+ size_t countEOL(const std::vector<char> &buff, size_t sz) {
+ size_t newlines = 0;
+ const char *p = &buff[0];
+ for (size_t i = 0; i < sz; i++) {
+ if (p[i] == '\n') {
+ newlines++;
+ }
+ }
+ return newlines;
+ }
+
+ size_t countLines(const std::string &filename) {
+ const size_t BUFFER_SIZE = 1024 * 1024;
+ std::vector<char> buffer(BUFFER_SIZE);
+ std::ifstream in(filename.c_str());
+ size_t n = 0;
+ while (size_t cc = read(in, buffer)) {
+ n += countEOL(buffer, cc);
+ }
+ return n;
+ }
+
+ bool loadWorkspace(const std::string &filename, const std::string wsName) {
+ LoadNexusProcessed load;
+ load.initialize();
+ load.setProperty("Filename", filename);
+ load.setProperty("OutputWorkspace", wsName);
+ load.execute();
+ return load.isExecuted();
+ }
+
+ void test_exec() {
+ // name of workspace to create and save
+ const std::string wsName("SaveRMCProfileTest_OutputWS");
+ // name of the output file
+ const std::string outFilename("SaveRMCProfileTest_Output.fq");
+
+ // Load a file to save out
+ TS_ASSERT(loadWorkspace("nom_gr.nxs", wsName));
+
+ // save the file
+ SaveRMCProfile alg;
+ TS_ASSERT_THROWS_NOTHING(alg.initialize())
+ TS_ASSERT(alg.isInitialized())
+ TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("InputWorkspace", wsName));
+ TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("InputType", "S(Q)"));
+ TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("Title", "nom_gr"));
+ TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("Filename", outFilename));
+ TS_ASSERT_THROWS_NOTHING(alg.execute(););
+ TS_ASSERT(alg.isExecuted());
+
+ // do the checks
+ Poco::File outFile(outFilename);
+ TS_ASSERT(outFile.isFile());
+ TS_ASSERT_EQUALS(countLines(outFilename), 1002);
+
+ // Remove workspace from the data service.
+ AnalysisDataService::Instance().remove(wsName);
+
+ // remove the output file
+ outFile.remove(false);
+ }
+
+ void test_exec_ws_group() {
+ // Create a group
+ const std::string groupName("SaveRMCProfileGroup");
+ TS_ASSERT(loadWorkspace("nom_gr.nxs", groupName + "_1"));
+ TS_ASSERT(loadWorkspace("nom_gr.nxs", groupName + "_2"));
+
+ auto grpAlg =
+ AlgorithmManager::Instance().createUnmanaged("GroupWorkspaces");
+ grpAlg->initialize();
+ grpAlg->setPropertyValue("InputWorkspaces",
+ groupName + "_1," + groupName + "_2");
+ grpAlg->setPropertyValue("OutputWorkspace", groupName);
+ grpAlg->execute();
+
+ // name of the output file
+ const std::string outFilename("SaveRMCProfileGroup.gr");
+
+ // run the algorithm with a group
+ SaveRMCProfile alg;
+ TS_ASSERT_THROWS_NOTHING(alg.initialize());
+ TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("InputWorkspace", groupName));
+ TS_ASSERT_THROWS_NOTHING(
+ alg.setPropertyValue("Filename", "SaveRMCProfileGroup.gr"));
+ TS_ASSERT_THROWS_NOTHING(alg.execute());
+ TS_ASSERT(alg.isExecuted());
+
+ // do the checks
+ Poco::File outFile(outFilename);
+ TS_ASSERT(outFile.isFile());
+ TS_ASSERT_EQUALS(countLines(outFilename), 1002);
+
+ // remove the workspace group
+ AnalysisDataService::Instance().deepRemoveGroup(groupName);
+ }
+};
+
+#endif /* MANTID_DATAHANDLING_SAVERMCPROFILETEST_H_ */
diff --git a/Framework/Properties/Mantid.properties.template b/Framework/Properties/Mantid.properties.template
index e5726fd6006ce24bdf71ded0f64eed1ba63c4dd5..b7e0b58c127b816b0fa8047f241c4770d4de3765 100644
--- a/Framework/Properties/Mantid.properties.template
+++ b/Framework/Properties/Mantid.properties.template
@@ -21,7 +21,7 @@ Q.convention = Inelastic
# Set of PyQt interfaces to add to the Interfaces menu, separated by a space. Interfaces are seperated from their respective categories by a "/".
-mantidqt.python_interfaces = Direct/DGS_Reduction.py Direct/DGSPlanner.py Direct/PyChop.py Direct/MSlice.py SANS/ORNL_SANS.py Utility/TofConverter.py Reflectometry/ISIS_Reflectometry_Old.py Diffraction/Powder_Diffraction_Reduction.py Utility/FilterEvents.py Diffraction/HFIR_4Circle_Reduction.py Utility/QECoverage.py SANS/ISIS_SANS.py Muon/Frequency_Domain_Analysis.py Muon/Elemental_Analysis.py Muon/Frequency_Domain_Analysis_Old.py Muon/Muon_Analysis.py
+mantidqt.python_interfaces = Direct/DGS_Reduction.py Direct/DGSPlanner.py Direct/PyChop.py Direct/MSlice.py SANS/ORNL_SANS.py Utility/TofConverter.py Diffraction/Powder_Diffraction_Reduction.py Utility/FilterEvents.py Diffraction/HFIR_4Circle_Reduction.py Utility/QECoverage.py SANS/ISIS_SANS.py Muon/Frequency_Domain_Analysis.py Muon/Elemental_Analysis.py Muon/Frequency_Domain_Analysis_Old.py Muon/Muon_Analysis.py
# Directory containing the above startup scripts
mantidqt.python_interfaces_directory = @MANTID_ROOT@/scripts
diff --git a/Framework/PythonInterface/core/CMakeLists.txt b/Framework/PythonInterface/core/CMakeLists.txt
index 7e2d1449c22f916a3b14028d39da596c95b92430..0cf6503620a9e0142869381e9be93801746a9735 100644
--- a/Framework/PythonInterface/core/CMakeLists.txt
+++ b/Framework/PythonInterface/core/CMakeLists.txt
@@ -11,6 +11,7 @@ set(
src/GlobalInterpreterLock.cpp
src/NDArray.cpp
src/ReleaseGlobalInterpreterLock.cpp
+ src/UninstallTrace.cpp
src/WrapperHelpers.cpp
src/Converters/CloneToNDArray.cpp
src/Converters/DateAndTime.cpp
@@ -39,6 +40,7 @@ set(
inc/MantidPythonInterface/core/ReleaseGlobalInterpreterLock.h
inc/MantidPythonInterface/core/StlExportDefinitions.h
inc/MantidPythonInterface/core/TypedValidatorExporter.h
+ inc/MantidPythonInterface/core/UninstallTrace.h
inc/MantidPythonInterface/core/VersionCompat.h
inc/MantidPythonInterface/core/WrapperHelpers.h
inc/MantidPythonInterface/core/WrapPython.h
diff --git a/Framework/PythonInterface/core/inc/MantidPythonInterface/core/UninstallTrace.h b/Framework/PythonInterface/core/inc/MantidPythonInterface/core/UninstallTrace.h
new file mode 100644
index 0000000000000000000000000000000000000000..84526336454bb68da54520d259a0475a91e8c2f7
--- /dev/null
+++ b/Framework/PythonInterface/core/inc/MantidPythonInterface/core/UninstallTrace.h
@@ -0,0 +1,31 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef MANTID_PYTHONINTERFACE_UNINSTALLTRACE_H
+#define MANTID_PYTHONINTERFACE_UNINSTALLTRACE_H
+
+#include "MantidPythonInterface/core/DllConfig.h"
+#include "MantidPythonInterface/core/WrapPython.h"
+
+namespace Mantid::PythonInterface {
+
+/**
+ * @brief RAII handler to temporarily remove and reinstall a Python trace
+ * function
+ */
+class MANTID_PYTHONINTERFACE_CORE_DLL UninstallTrace {
+public:
+ UninstallTrace();
+ ~UninstallTrace();
+
+private:
+ Py_tracefunc m_tracefunc;
+ PyObject *m_tracearg;
+};
+
+} // namespace Mantid::PythonInterface
+
+#endif // MANTID_PYTHONINTERFACE_UNINSTALLTRACE_H
diff --git a/Framework/PythonInterface/core/src/UninstallTrace.cpp b/Framework/PythonInterface/core/src/UninstallTrace.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..c83a30c9816fe3c9f2434c8a208e13de450ed8f8
--- /dev/null
+++ b/Framework/PythonInterface/core/src/UninstallTrace.cpp
@@ -0,0 +1,29 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "MantidPythonInterface/core/UninstallTrace.h"
+
+namespace Mantid::PythonInterface {
+
+/**
+ * Saves any function and argument previously set by PyEval_SetTrace
+ * and calls PyEval_SetTrace(nullptr, nullptr) to remove the trace function
+ */
+UninstallTrace::UninstallTrace() {
+ PyThreadState *curThreadState = PyThreadState_GET();
+ m_tracefunc = curThreadState->c_tracefunc;
+ m_tracearg = curThreadState->c_traceobj;
+ Py_XINCREF(m_tracearg);
+ PyEval_SetTrace(nullptr, nullptr);
+}
+
+/**
+ * Reinstates any trace function with PyEval_SetTrace and any saved arguments
+ * from the constructor
+ */
+UninstallTrace::~UninstallTrace() { PyEval_SetTrace(m_tracefunc, m_tracearg); }
+
+} // namespace Mantid::PythonInterface
diff --git a/Framework/PythonInterface/mantid/api/src/Exports/AlgorithmFactory.cpp b/Framework/PythonInterface/mantid/api/src/Exports/AlgorithmFactory.cpp
index 5645df888c71c296fb2e1c30b114c6ec81dcd3df..81a4f61607c95f6319642747416d6a6d29889fb8 100644
--- a/Framework/PythonInterface/mantid/api/src/Exports/AlgorithmFactory.cpp
+++ b/Framework/PythonInterface/mantid/api/src/Exports/AlgorithmFactory.cpp
@@ -10,6 +10,7 @@
#include "MantidKernel/WarningSuppressions.h"
#include "MantidPythonInterface/core/GetPointer.h"
#include "MantidPythonInterface/core/PythonObjectInstantiator.h"
+#include "MantidPythonInterface/core/UninstallTrace.h"
#include <boost/python/class.hpp>
#include <boost/python/def.hpp>
@@ -26,6 +27,7 @@
using namespace Mantid::API;
using namespace boost::python;
using Mantid::PythonInterface::PythonObjectInstantiator;
+using Mantid::PythonInterface::UninstallTrace;
GET_POINTER_SPECIALIZATION(AlgorithmFactoryImpl)
@@ -117,6 +119,7 @@ GNU_DIAG_OFF("cast-qual")
* or an instance of a class type derived from PythonAlgorithm
*/
void subscribe(AlgorithmFactoryImpl &self, const boost::python::object &obj) {
+ UninstallTrace uninstallTrace;
std::lock_guard<std::recursive_mutex> lock(PYALG_REGISTER_MUTEX);
static auto *const pyAlgClass =
diff --git a/Framework/PythonInterface/mantid/api/src/Exports/FunctionFactory.cpp b/Framework/PythonInterface/mantid/api/src/Exports/FunctionFactory.cpp
index e9d21d659a2cf10a6b4367d3939a7fe0e25cadfb..dda2948b6c02ed34dce5cf3894d3cec2190af90b 100644
--- a/Framework/PythonInterface/mantid/api/src/Exports/FunctionFactory.cpp
+++ b/Framework/PythonInterface/mantid/api/src/Exports/FunctionFactory.cpp
@@ -13,6 +13,7 @@
#include "MantidPythonInterface/api/PythonAlgorithm/AlgorithmAdapter.h"
#include "MantidPythonInterface/core/GetPointer.h"
#include "MantidPythonInterface/core/PythonObjectInstantiator.h"
+#include "MantidPythonInterface/core/UninstallTrace.h"
#include <boost/python/class.hpp>
#include <boost/python/def.hpp>
@@ -29,6 +30,7 @@ using Mantid::API::IBackgroundFunction;
using Mantid::API::IFunction;
using Mantid::API::IPeakFunction;
using Mantid::PythonInterface::PythonObjectInstantiator;
+using Mantid::PythonInterface::UninstallTrace;
using namespace boost::python;
@@ -172,11 +174,10 @@ std::recursive_mutex FUNCTION_REGISTER_MUTEX;
* @param classObject A Python class derived from IFunction
*/
void subscribe(FunctionFactoryImpl &self, PyObject *classObject) {
+ UninstallTrace uninstallTrace;
std::lock_guard<std::recursive_mutex> lock(FUNCTION_REGISTER_MUTEX);
static auto *baseClass = const_cast<PyTypeObject *>(
converter::registered<IFunction>::converters.to_python_target_type());
- // object mantidapi(handle<>(PyImport_ImportModule("mantid.api")));
- // object ifunction = mantidapi.attr("IFunction");
// obj should be a class deriving from IFunction
// PyObject_IsSubclass can set the error handler if classObject
diff --git a/Framework/PythonInterface/mantid/plots/__init__.py b/Framework/PythonInterface/mantid/plots/__init__.py
index 30c9197a508600595f2512f590d11e5a500026e1..95ee170792d22f000f0393b9ae220b92389f595d 100644
--- a/Framework/PythonInterface/mantid/plots/__init__.py
+++ b/Framework/PythonInterface/mantid/plots/__init__.py
@@ -15,1369 +15,23 @@ Functionality for unpacking mantid objects for plotting with matplotlib.
# of the main package.
from __future__ import (absolute_import, division, print_function)
+
try:
from collections.abc import Iterable
except ImportError:
# check Python 2 location
from collections import Iterable
-from matplotlib.axes import Axes
-from matplotlib.collections import Collection, PolyCollection
-from matplotlib.colors import Colormap
-from matplotlib.container import Container, ErrorbarContainer
-from matplotlib.image import AxesImage
-from matplotlib.lines import Line2D
-from matplotlib.patches import Patch
from matplotlib.projections import register_projection
from matplotlib.scale import register_scale
-from matplotlib.table import Table
-from mpl_toolkits.mplot3d.axes3d import Axes3D
-from mantid.api import AnalysisDataService as ads
-from mantid.kernel import logger
-from mantid.plots import helperfunctions, plotfunctions, plotfunctions3D
+from mantid.plots import datafunctions, axesfunctions, axesfunctions3D
from mantid.plots.legend import convert_color_to_hex, LegendProperties
-from mantid.plots.helperfunctions import get_normalize_by_bin_width
+from mantid.plots.datafunctions import get_normalize_by_bin_width
from mantid.plots.scales import PowerScale, SquareScale
+from mantid.plots.mantidaxes import MantidAxes, MantidAxes3D, WATERFALL_XOFFSET_DEFAULT, WATERFALL_YOFFSET_DEFAULT
from mantid.plots.utility import (artists_hidden, autoscale_on_update,
legend_set_draggable, MantidAxType)
-WATERFALL_XOFFSET_DEFAULT, WATERFALL_YOFFSET_DEFAULT = 10, 20
-
-def plot_decorator(func):
- def wrapper(self, *args, **kwargs):
- func_value = func(self, *args, **kwargs)
- # Saves saving it on array objects
- if helperfunctions.validate_args(*args, **kwargs):
- # Fill out kwargs with the values of args
- kwargs["workspaces"] = args[0].name()
- kwargs["function"] = func.__name__
-
- if 'wkspIndex' not in kwargs and 'specNum' not in kwargs:
- kwargs['specNum'] = MantidAxes.get_spec_number_or_bin(args[0], kwargs)
- if "cmap" in kwargs and isinstance(kwargs["cmap"], Colormap):
- kwargs["cmap"] = kwargs["cmap"].name
- self.creation_args.append(kwargs)
- return func_value
-
- return wrapper
-
-
-class _WorkspaceArtists(object):
- """Captures information regarding an artist that has been plotted
- from a workspace. It allows for removal and replacement of said artists
-
- """
- def __init__(self,
- artists,
- data_replace_cb,
- is_normalized,
- workspace_name=None,
- spec_num=None,
- is_spec=True):
- """
- Initialize an instance
- :param artists: A reference to a list of artists "attached" to a workspace
- :param data_replace_cb: A reference to a callable with signature (artists, workspace) -> new_artists
- :param is_normalized: bool specifying whether the line being plotted is a distribution
- :param workspace_name: String. The name of the associated workspace
- :param spec_num: The spectrum number of the spectrum used to plot the artist
- :param is_spec: True if spec_num represents a spectrum rather than a bin
- """
- self._set_artists(artists)
- self._data_replace_cb = data_replace_cb
- self.workspace_name = workspace_name
- self.spec_num = spec_num
- self.is_spec = is_spec
- self.workspace_index = self._get_workspace_index()
- self.is_normalized = is_normalized
-
- def _get_workspace_index(self):
- """Get the workspace index (spectrum or bin index) of the workspace artist"""
- if self.spec_num is None or self.workspace_name is None:
- return None
- try:
- if self.is_spec:
- return ads.retrieve(self.workspace_name).getIndexFromSpectrumNumber(self.spec_num)
- else:
- return self.spec_num
- except KeyError: # Return None if the workspace is not in the ADS
- return None
-
- def remove(self, axes):
- """
- Remove the tracked artists from the given axes
- :param axes: A reference to the axes instance the artists are attached to
- """
- # delete the artists from the axes
- self._remove(axes, self._artists)
-
- def remove_if(self, axes, predicate):
- """
- Remove the tracked artists from the given axes if they return true from predicate
- :param axes: A reference to the axes instance the artists are attached to
- :param predicate: A function which takes a matplotlib artist object and returns a boolean
- :returns: Returns a bool specifying whether the class is now empty
- """
- artists_to_remove = []
- artists_to_keep = []
- for artist in self._artists:
- if predicate(artist):
- artists_to_remove.append(artist)
- else:
- artists_to_keep.append(artist)
-
- self._remove(axes, artists_to_remove)
- self._artists = artists_to_keep
-
- return len(self._artists) == 0
-
- def _remove(self, axes, artists):
- # delete the artists from the axes
- for artist in artists:
- artist.remove()
- # Remove doesn't catch removing the container for errorbars etc
- if isinstance(artist, Container):
- try:
- axes.containers.remove(artist)
- except ValueError:
- pass
-
- if (not axes.is_empty(axes)) and axes.legend_ is not None:
- axes.make_legend()
-
- def replace_data(self, workspace, plot_kwargs=None):
- """Replace or replot artists based on a new workspace
- :param workspace: The new workspace containing the data
- :param plot_kwargs: Key word args to pass to plotting function
- """
- if plot_kwargs:
- new_artists = self._data_replace_cb(self._artists, workspace, plot_kwargs)
- else:
- new_artists = self._data_replace_cb(self._artists, workspace)
- self._set_artists(new_artists)
- return len(self._artists) == 0
-
- def _set_artists(self, artists):
- """Ensure the stored artists is an iterable"""
- if isinstance(artists, Container) or not isinstance(artists, Iterable):
- self._artists = [artists]
- else:
- self._artists = artists
-
-
-class MantidAxes(Axes):
- """
- This class defines the **mantid** projection for 2d plotting. One chooses
- this projection using::
-
- import matplotlib.pyplot as plt
- from mantid import plots
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
-
- or::
-
- import matplotlib.pyplot as plt
- from mantid import plots
- fig = plt.figure()
- ax = fig.add_subplot(111,projection='mantid')
-
- The mantid projection allows replacing the array objects with mantid workspaces.
- """
- # Required by Axes base class
- name = 'mantid'
-
- # Store information for any workspaces attached to this axes instance
- tracked_workspaces = None
-
- def __init__(self, *args, **kwargs):
- super(MantidAxes, self).__init__(*args, **kwargs)
- self.tracked_workspaces = dict()
- self.creation_args = []
- self.interactive_markers = []
- # flag to indicate if a function has been set to replace data
- self.data_replaced = False
-
- self.waterfall_x_offset = 0
- self.waterfall_y_offset = 0
-
- def add_artist_correctly(self, artist):
- """
- Add an artist via the correct function.
- MantidAxes will not correctly track artists added via :code:`add_artist`.
- They must be added via the correct function for features like
- autoscaling to work.
-
- :param artist: A Matplotlib Artist object
- """
- artist.set_transform(self.transData)
- if artist.axes:
- artist.remove()
- if isinstance(artist, Line2D):
- self.add_line(artist)
- elif isinstance(artist, Collection):
- self.add_collection(artist)
- elif isinstance(artist, Container):
- self.add_container(artist)
- elif isinstance(artist, AxesImage):
- self.add_image(artist)
- elif isinstance(artist, Patch):
- self.add_patch(artist)
- elif isinstance(artist, Table):
- self.add_table(artist)
- else:
- self.add_artist(artist)
-
- @staticmethod
- def from_mpl_axes(ax, ignore_artists=None):
- """
- Returns a MantidAxes from an Axes object.
- Transfers all transferable artists from a Matplotlib.Axes
- instance to a MantidAxes instance on the same figure. Then
- removes the Matplotlib.Axes.
-
- :param ax: An Axes object
- :param ignore_artists: List of Artist types to ignore
- :returns: A MantidAxes object
- """
- if not ignore_artists:
- ignore_artists = []
- prop_cycler = ax._get_lines.prop_cycler # tracks line color cycle
- artists = ax.get_children()
- mantid_axes = ax.figure.add_subplot(111, projection='mantid', label='mantid')
- for artist in artists:
- if not any(isinstance(artist, artist_type) for artist_type in ignore_artists):
- try:
- mantid_axes.add_artist_correctly(artist)
- except NotImplementedError:
- pass
- mantid_axes.set_title(ax.get_title())
- mantid_axes._get_lines.prop_cycler = prop_cycler
- ax.remove()
- return mantid_axes
-
- @staticmethod
- def is_axis_of_type(axis_type, kwargs):
- if kwargs.get('axis', None) is not None:
- return kwargs.get('axis', None) == axis_type
- return axis_type == MantidAxType.SPECTRUM
-
- @staticmethod
- def get_spec_num_from_wksp_index(workspace, wksp_index):
- return workspace.getSpectrum(wksp_index).getSpectrumNo()
-
- @staticmethod
- def get_spec_number_or_bin(workspace, kwargs):
- if kwargs.get('specNum', None) is not None:
- return kwargs['specNum']
- elif kwargs.get('wkspIndex', None) is not None:
- # If wanting to plot a bin
- if MantidAxes.is_axis_of_type(MantidAxType.BIN, kwargs):
- return kwargs['wkspIndex']
- # If wanting to plot a spectrum
- elif MantidAxes.is_axis_of_type(MantidAxType.SPECTRUM, kwargs):
- return MantidAxes.get_spec_num_from_wksp_index(workspace, kwargs['wkspIndex'])
- elif kwargs.get('LogName', None) is not None:
- return None
- elif getattr(workspace, 'getNumberHistograms', lambda: -1)() == 1:
- # If the workspace has one histogram, just plot that
- kwargs['wkspIndex'] = 0
- if MantidAxes.is_axis_of_type(MantidAxType.BIN, kwargs):
- return kwargs['wkspIndex']
- return MantidAxes.get_spec_num_from_wksp_index(workspace, kwargs['wkspIndex'])
- else:
- return None
-
- def get_workspace_name_from_artist(self, artist):
- for ws_name, ws_artists_list in self.tracked_workspaces.items():
- for ws_artists in ws_artists_list:
- for ws_artist in ws_artists._artists:
- if artist == ws_artist:
- return ws_name
-
- def get_artists_workspace_and_spec_num(self, artist):
- """Retrieve the workspace and spec num of the given artist"""
- for ws_name, ws_artists_list in self.tracked_workspaces.items():
- for ws_artists in ws_artists_list:
- for ws_artist in ws_artists._artists:
- if artist == ws_artist:
- return ads.retrieve(ws_name), ws_artists.spec_num
- raise ValueError("Artist: '{}' not tracked by axes.".format(artist))
-
- def get_artist_normalization_state(self, artist):
- for ws_name, ws_artists_list in self.tracked_workspaces.items():
- for ws_artists in ws_artists_list:
- for ws_artist in ws_artists._artists:
- if artist == ws_artist:
- return ws_artists.is_normalized
-
- def track_workspace_artist(self,
- workspace,
- artists,
- data_replace_cb=None,
- spec_num=None,
- is_normalized=None,
- is_spec=True):
- """
- Add the given workspace's name to the list of workspaces
- displayed on this Axes instance
- :param workspace: A Workspace object. If empty then no tracking takes place
- :param artists: A single artist or iterable of artists containing the data for the workspace
- :param data_replace_cb: A function to call when the data is replaced to update
- the artist (optional)
- :param spec_num: The spectrum number associated with the artist (optional)
- :param is_normalized: bool. The line being plotted is normalized by bin width
- This can be from either a distribution workspace or a workspace being
- plotted as a distribution
- :param is_spec: bool. True if spec_num represents a spectrum, and False if it is a bin index
- :returns: The artists variable as it was passed in.
- """
- name = workspace.name()
- if name:
- if data_replace_cb is None:
- def data_replace_cb(*args):
- logger.warning("Updating data on this plot type is not yet supported")
- else:
- self.data_replaced = True
-
- artist_info = self.tracked_workspaces.setdefault(name, [])
-
- artist_info.append(
- _WorkspaceArtists(artists, data_replace_cb, is_normalized, name, spec_num, is_spec))
- self.check_axes_distribution_consistency()
- return artists
-
- def check_axes_distribution_consistency(self):
- """
- Checks if the curves on the axes are all normalized or all
- non-normalized and displays a warning if not.
- """
- tracked_ws_distributions = []
- for artists in self.tracked_workspaces.values():
- for artist in artists:
- if artist.is_normalized is not None:
- tracked_ws_distributions.append(artist.is_normalized)
-
- if len(tracked_ws_distributions) > 0:
- num_normalized = sum(tracked_ws_distributions)
- if not (num_normalized == 0 or num_normalized == len(tracked_ws_distributions)):
- logger.warning("You are overlaying distribution and non-distribution data!")
-
- def artists_workspace_has_errors(self, artist):
- """Check if the given artist's workspace has errors"""
- if artist not in self.get_tracked_artists():
- raise ValueError("Artist '{}' is not tracked and so does not have "
- "an associated workspace.".format(artist))
- workspace, spec_num = self.get_artists_workspace_and_spec_num(artist)
- if artist.axes.creation_args[0].get('axis', None) == MantidAxType.BIN:
- if any([workspace.readE(i)[spec_num] != 0 for i in range(0, workspace.getNumberHistograms())]):
- return True
- else:
- workspace_index = workspace.getIndexFromSpectrumNumber(spec_num)
- if any(workspace.readE(workspace_index) != 0):
- return True
- return False
-
- def get_tracked_artists(self):
- """Get the Matplotlib artist objects that are tracked"""
- tracked_artists = []
- for ws_artists_list in self.tracked_workspaces.values():
- for ws_artists in ws_artists_list:
- for artist in ws_artists._artists:
- tracked_artists.append(artist)
- return tracked_artists
-
- def remove_workspace_artists(self, workspace):
- """
- Remove the artists reference by this workspace (if any) and return True
- if the axes is then empty
- :param workspace: A Workspace object
- :return: True if the axes is empty, false if artists remain or this workspace is not associated here
- """
- try:
- # pop to ensure we don't hold onto an artist reference
- artist_info = self.tracked_workspaces.pop(workspace.name())
- except KeyError:
- return False
-
- for workspace_artist in artist_info:
- workspace_artist.remove(self)
-
- return self.is_empty(self)
-
- def remove_artists_if(self, unary_predicate):
- """
- Remove any artists which satisfy the predicate and return True
- if the axes is then empty
- :param unary_predicate: A predicate taking a single matplotlib artist object
- :return: True if the axes is empty, false if artists remain
- """
- is_empty_list = []
- for workspace_name, artist_info in self.tracked_workspaces.items():
- is_empty = self._remove_artist_info_if(artist_info, unary_predicate)
- if is_empty:
- is_empty_list.append(workspace_name)
-
- for workspace_name in is_empty_list:
- self.tracked_workspaces.pop(workspace_name)
-
- # Catch any artists that are not tracked
- for artist in self.artists + self.lines + self.containers + self.images:
- if unary_predicate(artist):
- artist.remove()
- if isinstance(artist, ErrorbarContainer):
- self.containers.remove(artist)
-
- return self.is_empty(self)
-
- def _remove_artist_info_if(self, artist_info, unary_predicate):
- """
- Remove any artists which satisfy the predicate from the artist_info_list
- :param artist_info: A list of _WorkspaceArtists objects
- :param unary_predicate: A predicate taking a single matplotlib artist object
- :return: True if the artist_info is empty, false if artist_info remain
- """
- is_empty_list = [workspace_artist.remove_if(self, unary_predicate) for workspace_artist in artist_info]
-
- for index, empty in reversed(list(enumerate(is_empty_list))):
- if empty:
- artist_info.pop(index)
-
- return len(artist_info) == 0
-
- def replace_workspace_artists(self, workspace):
- """
- Replace the data of any artists relating to this workspace.
- The axes are NOT redrawn
- :param workspace: The workspace containing the new data
- :return : True if data was replaced, false otherwise
- """
- try:
- artist_info = self.tracked_workspaces[workspace.name()]
- except KeyError:
- return False
-
- is_empty_list = [workspace_artist.replace_data(workspace) for workspace_artist in artist_info]
-
- for index, empty in reversed(list(enumerate(is_empty_list))):
- if empty:
- artist_info.pop(index)
-
- return True
-
- def replot_artist(self, artist, errorbars=False, **kwargs):
- """
- Replot an artist with a new set of kwargs via 'plot' or 'errorbar'
- :param artist: The artist to replace
- :param errorbars: Plot with or without errorbars
- :returns: The new artist that has been plotted
- For keywords related to workspaces, see :func:`plotfunctions.plot` or
- :func:`plotfunctions.errorbar`
- """
- kwargs['distribution'] = not self.get_artist_normalization_state(artist)
- workspace, spec_num = self.get_artists_workspace_and_spec_num(artist)
- self.remove_artists_if(lambda art: art == artist)
- if kwargs.get('axis', None) == MantidAxType.BIN:
- workspace_index = spec_num
- else:
- workspace_index = workspace.getIndexFromSpectrumNumber(spec_num)
- self._remove_matching_curve_from_creation_args(workspace.name(), workspace_index, spec_num)
-
- if errorbars:
- new_artist = self.errorbar(workspace, wkspIndex=workspace_index, **kwargs)
- else:
- new_artist = self.plot(workspace, wkspIndex=workspace_index, **kwargs)
- return new_artist
-
- def relim(self, visible_only=True):
- # Hiding the markers during the the relim ensures they are not factored
- # in (assuming that visible_only is True)
- with artists_hidden(self.interactive_markers):
- Axes.relim(self, visible_only) # relim on any non-errorbar objects
- lower_xlim, lower_ylim = self.dataLim.get_points()[0]
- upper_xlim, upper_ylim = self.dataLim.get_points()[1]
- for container in self.containers:
- if isinstance(container, ErrorbarContainer) and (
- (visible_only and not helperfunctions.errorbars_hidden(container))
- or not visible_only):
- min_x, max_x, min_y, max_y = helperfunctions.get_errorbar_bounds(container)
- lower_xlim = min(lower_xlim, min_x) if min_x else lower_xlim
- upper_xlim = max(upper_xlim, max_x) if max_x else upper_xlim
- lower_ylim = min(lower_ylim, min_y) if min_y else lower_ylim
- upper_ylim = max(upper_ylim, max_y) if max_y else upper_ylim
-
- xys = [[lower_xlim, lower_ylim], [upper_xlim, upper_ylim]]
- # update_datalim will update limits with union of current lims and xys
- self.update_datalim(xys)
-
- def make_legend(self):
- if self.legend_ is None:
- legend_set_draggable(self.legend(), True)
- else:
- props = LegendProperties.from_legend(self.legend_)
- LegendProperties.create_legend(props, self)
-
- @staticmethod
- def is_empty(axes):
- """
- Checks the known artist containers to see if anything exists within them
- :return: True if no artists exist, false otherwise
- """
- def _empty(container):
- return len(container) == 0
-
- return (_empty(axes.lines) and _empty(axes.images) and _empty(axes.collections)
- and _empty(axes.containers))
-
- def twinx(self):
- """
- Create a twin Axes sharing the xaxis
-
- Create a new Axes instance with an invisible x-axis and an independent
- y-axis positioned opposite to the original one (i.e. at right). The
- x-axis autoscale setting will be inherited from the original Axes.
- To ensure that the tick marks of both y-axes align, see
- `~matplotlib.ticker.LinearLocator`
-
- Returns
- -------
- ax_twin : Axes
- The newly created Axes instance
-
- Notes
- -----
- For those who are 'picking' artists while using twinx, pick
- events are only called for the artists in the top-most axes.
- """
- ax2 = self._make_twin_axes(sharex=self, projection='mantid')
- ax2.yaxis.tick_right()
- ax2.yaxis.set_label_position('right')
- ax2.yaxis.set_offset_position('right')
- ax2.set_autoscalex_on(self.get_autoscalex_on())
- self.yaxis.tick_left()
- ax2.xaxis.set_visible(False)
- ax2.patch.set_visible(False)
- return ax2
-
- def twiny(self):
- """
- Create a twin Axes sharing the yaxis
-
- Create a new Axes instance with an invisible y-axis and an independent
- x-axis positioned opposite to the original one (i.e. at top). The
- y-axis autoscale setting will be inherited from the original Axes.
- To ensure that the tick marks of both x-axes align, see
- `~matplotlib.ticker.LinearLocator`
-
- Returns
- -------
- ax_twin : Axes
- The newly created Axes instance
-
- Notes
- -----
- For those who are 'picking' artists while using twiny, pick
- events are only called for the artists in the top-most axes.
- """
- ax2 = self._make_twin_axes(sharey=self, projection='mantid')
- ax2.xaxis.tick_top()
- ax2.xaxis.set_label_position('top')
- ax2.set_autoscaley_on(self.get_autoscaley_on())
- self.xaxis.tick_bottom()
- ax2.yaxis.set_visible(False)
- ax2.patch.set_visible(False)
- return ax2
-
- @plot_decorator
- def plot(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.plot` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.plot(workspace,'rs',specNum=1) #for workspaces
- ax.plot(x,y,'bo') #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.plot`.
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions')
-
- autoscale_on = kwargs.pop("autoscale_on_update", self.get_autoscale_on())
-
- def _data_update(artists, workspace, new_kwargs=None):
- # It's only possible to plot 1 line at a time from a workspace
- try:
- if new_kwargs:
- x, y, _, _ = plotfunctions._plot_impl(self, workspace, args, new_kwargs)
- else:
- x, y, _, _ = plotfunctions._plot_impl(self, workspace, args, kwargs)
- artists[0].set_data(x, y)
- except RuntimeError as ex:
- # if curve couldn't be plotted then remove it - can happen if the workspace doesn't contain the
- # spectrum any more following execution of an algorithm
- logger.information('Curve not plotted: {0}'.format(ex.args[0]))
-
- # remove the curve using similar to logic that in _WorkspaceArtists._remove
- artists[0].remove()
-
- # blank out list that will be returned
- artists = []
-
- # also remove the curve from the legend
- if (not self.is_empty(self)) and self.legend_ is not None:
- legend_set_draggable(self.legend(), True)
-
- if new_kwargs:
- _autoscale_on = new_kwargs.pop("autoscale_on_update", self.get_autoscale_on())
- else:
- _autoscale_on = self.get_autoscale_on()
-
- if _autoscale_on:
- self.relim()
- self.autoscale()
- return artists
-
- workspace = args[0]
- spec_num = self.get_spec_number_or_bin(workspace, kwargs)
- normalize_by_bin_width, kwargs = get_normalize_by_bin_width(workspace, self, **kwargs)
- is_normalized = normalize_by_bin_width or workspace.isDistribution()
-
- with autoscale_on_update(self, autoscale_on):
- artist = self.track_workspace_artist(workspace,
- plotfunctions.plot(self, normalize_by_bin_width = is_normalized,
- *args, **kwargs),
- _data_update, spec_num, is_normalized,
- MantidAxes.is_axis_of_type(MantidAxType.SPECTRUM, kwargs))
- return artist
- else:
- return Axes.plot(self, *args, **kwargs)
-
- @plot_decorator
- def scatter(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.scatter` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.scatter(workspace,'rs',specNum=1) #for workspaces
- ax.scatter(x,y,'bo') #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.scatter`
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions')
- else:
- return Axes.scatter(self, *args, **kwargs)
-
- @plot_decorator
- def errorbar(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.errorbar` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.errorbar(workspace,'rs',specNum=1) #for workspaces
- ax.errorbar(x,y,yerr,'bo') #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.errorbar`
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions')
-
- autoscale_on = kwargs.pop("autoscale_on_update", self.get_autoscale_on())
-
- def _data_update(artists, workspace, new_kwargs=None):
- if new_kwargs:
- _autoscale_on = new_kwargs.pop("autoscale_on_update", self.get_autoscale_on())
- else:
- _autoscale_on = self.get_autoscale_on()
- # errorbar with workspaces can only return a single container
- container_orig = artists[0]
- # It is not possible to simply reset the error bars so
- # we have to plot new lines but ensure we don't reorder them on the plot!
- orig_idx = self.containers.index(container_orig)
- container_orig.remove()
- # The container does not remove itself from the containers list
- # but protect this just in case matplotlib starts doing this
- try:
- self.containers.remove(container_orig)
- except ValueError:
- pass
- # this gets pushed back onto the containers list
- try:
- with autoscale_on_update(self, _autoscale_on):
- # this gets pushed back onto the containers list
- if new_kwargs:
- container_new = plotfunctions.errorbar(self, workspace, **new_kwargs)
- else:
- container_new = plotfunctions.errorbar(self, workspace, **kwargs)
-
- self.containers.insert(orig_idx, container_new)
- self.containers.pop()
- # Update joining line
- if container_new[0] and container_orig[0]:
- container_new[0].update_from(container_orig[0])
- # Update caps
- for orig_caps, new_caps in zip(container_orig[1], container_new[1]):
- new_caps.update_from(orig_caps)
- # Update bars
- for orig_bars, new_bars in zip(container_orig[2], container_new[2]):
- new_bars.update_from(orig_bars)
- # Re-plotting in the config dialog will assign this attr
- if hasattr(container_orig, 'errorevery'):
- setattr(container_new, 'errorevery', container_orig.errorevery)
-
- # ax.relim does not support collections...
- self._update_line_limits(container_new[0])
- except RuntimeError as ex:
- logger.information('Error bar not plotted: {0}'.format(ex.args[0]))
- container_new = []
- # also remove the curve from the legend
- if (not self.is_empty(self)) and self.legend_ is not None:
- legend_set_draggable(self.legend(), True)
-
- return container_new
-
- workspace = args[0]
- spec_num = self.get_spec_number_or_bin(workspace, kwargs)
- is_normalized, kwargs = get_normalize_by_bin_width(workspace, self, **kwargs)
-
- with autoscale_on_update(self, autoscale_on):
- artist = self.track_workspace_artist(workspace,
- plotfunctions.errorbar(self, *args, **kwargs),
- _data_update, spec_num, is_normalized,
- MantidAxes.is_axis_of_type(MantidAxType.SPECTRUM, kwargs))
- return artist
- else:
- return Axes.errorbar(self, *args, **kwargs)
-
- @plot_decorator
- def pcolor(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.pcolor` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.pcolor(workspace) #for workspaces
- ax.pcolor(x,y,C) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.pcolor`
- """
- return self._plot_2d_func('pcolor', *args, **kwargs)
-
- @plot_decorator
- def pcolorfast(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.pcolorfast` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matpolotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.pcolorfast(workspace) #for workspaces
- ax.pcolorfast(x,y,C) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.pcolorfast`
- """
- return self._plot_2d_func('pcolorfast', *args, **kwargs)
-
- @plot_decorator
- def pcolormesh(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.pcolormesh` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.pcolormesh(workspace) #for workspaces
- ax.pcolormesh(x,y,C) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.pcolormesh`
- """
- return self._plot_2d_func('pcolormesh', *args, **kwargs)
-
- @plot_decorator
- def imshow(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.imshow` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.imshow(workspace) #for workspaces
- ax.imshow(C) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.imshow`
- """
- return self._plot_2d_func('imshow', *args, **kwargs)
-
- def _plot_2d_func(self, name, *args, **kwargs):
- """
- Implementation of pcolor-style methods
- :param name: The name of the method
- :param args: The args passed from the user
- :param kwargs: The kwargs passed from the use
- :return: The return value of the pcolor* function
- """
- plotfunctions_func = getattr(plotfunctions, name)
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions')
-
- def _update_data(artists, workspace, new_kwargs=None):
- if new_kwargs:
- return self._redraw_colorplot(plotfunctions_func, artists, workspace,
- **new_kwargs)
- return self._redraw_colorplot(plotfunctions_func, artists, workspace, **kwargs)
-
- workspace = args[0]
- normalize_by_bin_width, _ = get_normalize_by_bin_width(workspace, self, **kwargs)
- is_normalized = normalize_by_bin_width or \
- (hasattr(workspace, 'isDistribution') and workspace.isDistribution())
- # We return the last mesh so the return type is a single artist like the standard Axes
- artists = self.track_workspace_artist(workspace,
- plotfunctions_func(self, *args, **kwargs),
- _update_data, is_normalized=is_normalized)
- try:
- return artists[-1]
- except TypeError:
- return artists
- else:
- return getattr(Axes, name)(self, *args, **kwargs)
-
- def _redraw_colorplot(self, colorfunc, artists_orig, workspace, **kwargs):
- """
- Redraw a pcolor*, imshow or contour type plot based on a new workspace
- :param colorfunc: The Axes function to use to draw the new artist
- :param artists_orig: A reference to an iterable of existing artists
- :param workspace: A reference to the workspace object
- :param kwargs: Any kwargs passed to the original call
- """
- for artist_orig in artists_orig:
- if hasattr(artist_orig, 'remove'):
- artist_orig.remove()
- else: # for contour plots remove the collections
- for col in artist_orig.collections:
- col.remove()
- if hasattr(artist_orig, 'colorbar_cid'):
- artist_orig.callbacksSM.disconnect(artist_orig.colorbar_cid)
- if artist_orig.norm.vmin == 0: # avoid errors with log 0
- artist_orig.norm.vmin += 1e-6
- artists_new = colorfunc(self, workspace, norm=artist_orig.norm, **kwargs)
-
- artists_new.set_cmap(artist_orig.cmap)
- if hasattr(artist_orig, 'interpolation'):
- artists_new.set_interpolation(artist_orig.get_interpolation())
-
- artists_new.autoscale()
- artists_new.set_norm(
- type(artist_orig.norm)(vmin=artists_new.norm.vmin, vmax=artists_new.norm.vmax))
-
- if not isinstance(artists_new, Iterable):
- artists_new = [artists_new]
-
- try:
- plotfunctions.update_colorplot_datalimits(self, artists_new)
- except ValueError:
- pass
- # the type of plot can mutate back to single image from a multi collection
- if len(artists_orig) == len(artists_new):
- for artist_orig, artist_new in zip(artists_orig, artists_new):
- if artist_orig.colorbar is not None:
- self._attach_colorbar(artist_new, artist_orig.colorbar)
- else:
- # pick up the colorbar from the first one we find
- for artist_orig in artists_orig:
- if artist_orig.colorbar is not None:
- self._attach_colorbar(artists_new[-1], artist_orig.colorbar)
- break
- self.set_aspect('auto')
- return artists_new
-
- @plot_decorator
- def contour(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.contour` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.contour(workspace) #for workspaces
- ax.contour(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.contour`
- """
- return self._plot_2d_func('contour', *args, **kwargs)
-
- @plot_decorator
- def contourf(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.contourf` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.contourf(workspace) #for workspaces
- ax.contourf(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.contourf`
- """
- return self._plot_2d_func('contourf', *args, **kwargs)
-
- @plot_decorator
- def tripcolor(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.tripcolor` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.tripcolor(workspace) #for workspaces
- ax.tripcolor(x,y,C) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.tripcolor`
- """
- return self._plot_2d_func('tripcolor', *args, **kwargs)
-
- @plot_decorator
- def tricontour(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.tricontour` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.tricontour(workspace) #for workspaces
- ax.tricontour(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.tricontour`
- """
- return self._plot_2d_func('tricontour', *args, **kwargs)
-
- @plot_decorator
- def tricontourf(self, *args, **kwargs):
- """
- If the **mantid** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes.tricontourf` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
- ax.tricontourf(workspace) #for workspaces
- ax.tricontourf(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions.tricontourf`
- """
- return self._plot_2d_func('tricontourf', *args, **kwargs)
-
- def is_waterfall(self):
- return self.waterfall_x_offset != 0 or self.waterfall_y_offset != 0
-
- def update_waterfall(self, x_offset, y_offset):
- """
- Changes the offset of a waterfall plot.
- :param x_offset: The amount by which each line is shifted in the x axis.
- :param y_offset: The amount by which each line is shifted in the y axis.
- """
- x_offset = int(x_offset)
- y_offset = int(y_offset)
-
- errorbar_cap_lines = helperfunctions.remove_and_return_errorbar_cap_lines(self)
-
- for i in range(len(self.get_lines())):
- helperfunctions.convert_single_line_to_waterfall(self, i, x_offset, y_offset)
-
- if x_offset == 0 and y_offset == 0:
- self.set_waterfall_fill(False)
- logger.information("x and y offset have been set to zero so the plot is no longer a waterfall plot.")
-
- if self.waterfall_has_fill():
- helperfunctions.waterfall_update_fill(self)
-
- self.waterfall_x_offset = x_offset
- self.waterfall_y_offset = y_offset
-
- self.lines += errorbar_cap_lines
-
- helperfunctions.set_waterfall_toolbar_options_enabled(self)
- self.get_figure().canvas.draw()
-
- def set_waterfall(self, state, x_offset=None, y_offset=None, fill=False):
- """
- Convert between a normal 1D plot and a waterfall plot.
- :param state: If true convert the plot to a waterfall plot, otherwise convert to a 1D plot.
- :param x_offset: The amount by which each line is shifted in the x axis. Optional, default is 10.
- :param y_offset: The amount by which each line is shifted in the y axis. Optional, default is 20.
- :param fill: If true the area under each line is filled.
- :raises: RuntimeError if state is true but there are less than two lines on the plot, if state is true but
- x_offset and y_offset are 0, or if state is false but x_offset or y_offset is non-zero or fill is True.
- """
- if state:
- if len(self.get_lines()) < 2:
- raise RuntimeError("Axis must have multiple lines to be converted to a waterfall plot.")
-
- if x_offset is None:
- x_offset = WATERFALL_XOFFSET_DEFAULT
-
- if y_offset is None:
- y_offset = WATERFALL_YOFFSET_DEFAULT
-
- if x_offset == 0 and y_offset == 0:
- raise RuntimeError("You have set waterfall to true but have set the x and y offsets to zero.")
-
- if self.is_waterfall():
- # If the plot is already a waterfall plot but the provided x or y offset value is different to the
- # current value, the new values are applied but a message is written to the logger to tell the user
- # that they can use the update_waterfall function to do this.
- if x_offset != self.waterfall_x_offset or y_offset != self.waterfall_y_offset:
- logger.information("If your plot is already a waterfall plot you can use update_waterfall(x, y) to"
- " change its offset values.")
- else:
- # Nothing needs to be changed.
- logger.information("Plot is already a waterfall plot.")
- return
-
- # Set the width and height attributes if they haven't been already.
- if not hasattr(self, 'width'):
- helperfunctions.set_initial_dimensions(self)
- else:
- if bool(x_offset) or bool(y_offset) or fill:
- raise RuntimeError("You have set waterfall to false but have given a non-zero value for the offset or "
- "set fill to true.")
-
- if not self.is_waterfall():
- # Nothing needs to be changed.
- logger.information("Plot is already not a waterfall plot.")
- return
-
- x_offset = y_offset = 0
-
- self.update_waterfall(x_offset, y_offset)
-
- if fill:
- self.set_waterfall_fill(True)
-
- def waterfall_has_fill(self):
- return any(isinstance(collection, PolyCollection) for collection in self.collections)
-
- def set_waterfall_fill(self, enable, colour=None):
- """
- Toggle whether the area under each line on a waterfall plot is filled.
- :param enable: If true, the filled areas are created, otherwise they are removed.
- :param colour: Optional string for the colour of the filled areas. If None, the colour of each line is used.
- :raises: RuntimeError if enable is false but colour is not None.
- """
- if not self.is_waterfall():
- raise RuntimeError("Cannot toggle fill on non-waterfall plot.")
-
- if enable:
- helperfunctions.waterfall_create_fill(self)
-
- if colour:
- helperfunctions.solid_colour_fill(self, colour)
- else:
- helperfunctions.line_colour_fill(self)
- else:
- if bool(colour):
- raise RuntimeError("You have set fill to false but have given a colour.")
-
- helperfunctions.waterfall_remove_fill(self)
-
- # ------------------ Private api --------------------------------------------------------
-
- def _attach_colorbar(self, mappable, colorbar):
- """
- Attach the given colorbar to the mappable and update the clim values
- :param mappable: An instance of a mappable
- :param colorbar: An instance of a colorbar
- """
- cb = colorbar
- cb.mappable = mappable
- cb.set_clim(mappable.get_clim())
- mappable.colorbar = cb
- mappable.colorbar_cid = mappable.callbacksSM.connect('changed', cb.on_mappable_changed)
- cb.update_normal(mappable)
-
- def _remove_matching_curve_from_creation_args(self, workspace_name, workspace_index, spec_num):
- """
- Finds a curve from the same workspace and index, then removes it from the creation args.
-
- :param workspace_name: Name of the workspace from which the curve was plotted
- :type workspace_name: str
- :param workspace_index: Index in the workspace that contained the data
- :type workspace_index: int
- :param spec_num: Spectrum number that contained the data. Used if the workspace was plotted using specNum kwarg.
- Workspace index has priority if both are provided.
- :type spec_num: int
- :raises ValueError: if the curve does not exist in the creation_args of the axis
- :returns: None
- """
- for index, creation_arg in enumerate(self.creation_args): # type: int, dict
- if workspace_name == creation_arg["workspaces"]:
- if creation_arg.get("wkspIndex", -1) == workspace_index or creation_arg.get(
- "specNum", -1) == spec_num:
- del self.creation_args[index]
- return
- raise ValueError("Curve does not have existing creation args")
-
-
-class MantidAxes3D(Axes3D):
- """
- This class defines the **mantid3d** projection for 3d plotting. One chooses
- this projection using::
-
- import matplotlib.pyplot as plt
- from mantid import plots
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
-
- or::
-
- import matplotlib.pyplot as plt
- from mantid import plots
- fig = plt.figure()
- ax = fig.add_subplot(111,projection='mantid3d')
-
- The mantid3d projection allows replacing the array objects with mantid workspaces.
- """
-
- name = 'mantid3d'
-
- def plot(self, *args, **kwargs):
- """
- If the **mantid3d** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes3D.plot` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
- ax.plot(workspace) #for workspaces
- ax.plot(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions3D.plot3D`
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions3D')
- return plotfunctions3D.plot(self, *args, **kwargs)
- else:
- return Axes3D.plot(self, *args, **kwargs)
-
- def scatter(self, *args, **kwargs):
- """
- If the **mantid3d** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes3D.scatter` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
- ax.scatter(workspace) #for workspaces
- ax.scatter(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions3D.scatter`
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions3D')
- return plotfunctions3D.scatter(self, *args, **kwargs)
- else:
- return Axes3D.scatter(self, *args, **kwargs)
-
- def plot_wireframe(self, *args, **kwargs):
- """
- If the **mantid3d** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes3D.plot_wireframe` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
- ax.plot_wireframe(workspace) #for workspaces
- ax.plot_wireframe(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions3D.wireframe`
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions3D')
- return plotfunctions3D.plot_wireframe(self, *args, **kwargs)
- else:
- return Axes3D.plot_wireframe(self, *args, **kwargs)
-
- def plot_surface(self, *args, **kwargs):
- """
- If the **mantid3d** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes3D.plot_surface` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
- ax.plot_surface(workspace) #for workspaces
- ax.plot_surface(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions3D.plot_surface`
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions3D')
- return plotfunctions3D.plot_surface(self, *args, **kwargs)
- else:
- return Axes3D.plot_surface(self, *args, **kwargs)
-
- def contour(self, *args, **kwargs):
- """
- If the **mantid3d** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes3D.contour` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
- ax.contour(workspace) #for workspaces
- ax.contour(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions3D.contour`
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions3D')
- return plotfunctions3D.contour(self, *args, **kwargs)
- else:
- return Axes3D.contour(self, *args, **kwargs)
-
- def contourf(self, *args, **kwargs):
- """
- If the **mantid3d** projection is chosen, it can be
- used the same as :py:meth:`matplotlib.axes.Axes3D.contourf` for arrays,
- or it can be used to plot :class:`mantid.api.MatrixWorkspace`
- or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
-
- import matplotlib.pyplot as plt
- from mantid import plots
-
- ...
-
- fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
- ax.contourf(workspace) #for workspaces
- ax.contourf(x,y,z) #for arrays
- fig.show()
-
- For keywords related to workspaces, see :func:`plotfunctions3D.contourf`
- """
- if helperfunctions.validate_args(*args):
- logger.debug('using plotfunctions3D')
- return plotfunctions3D.contourf(self, *args, **kwargs)
- else:
- return Axes3D.contourf(self, *args, **kwargs)
-
-
register_projection(MantidAxes)
register_projection(MantidAxes3D)
register_scale(PowerScale)
diff --git a/Framework/PythonInterface/mantid/plots/_compatability.py b/Framework/PythonInterface/mantid/plots/_compatability.py
new file mode 100644
index 0000000000000000000000000000000000000000..0ada948cb7a09da48de8a64df793982ae181d394
--- /dev/null
+++ b/Framework/PythonInterface/mantid/plots/_compatability.py
@@ -0,0 +1,100 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2017 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+# This file is part of the mantid package
+#
+#
+from __future__ import (absolute_import, division, print_function)
+
+# local imports
+from mantid.kernel import Logger
+from mantid.plots.utility import MantidAxType
+from mantid.plots.plotfunctions import plot
+
+# -----------------------------------------------------------------------------
+# Constants
+# -----------------------------------------------------------------------------
+LOGGER = Logger("mantid.plots.plotCompatability")
+# ================================================
+# Compatability functions
+# ================================================
+def plotSpectrum(workspaces, indices=None, distribution=None, error_bars=False,
+ type=None, window=None, clearWindow=None,
+ waterfall=None, spectrum_nums=None):
+ """
+ Create a figure with a single subplot and for each workspace/index add a
+ line plot to the new axes. show() is called before returning the figure instance
+
+ :param workspaces: Workspace/workspaces to plot as a string, workspace handle, list of strings or list of
+ workspaces handles.
+ :param indices: A single int or list of ints specifying the workspace indices to plot
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the workspace is a MatrixWorkspace histogram.
+ :param error_bars: If true then error bars will be added for each curve
+ :param type: curve style for plot it 1: scatter/dots otherwise line which is default
+ :param window: If passed an existing plot then the plot will occur in that plot
+ :param clearWindow: If true, and window set then the plot will be cleared before adding these curves
+ :param waterfall: If true then a waterfall plot will be produced
+ :param spectrum_nums: A single int or list of ints specifying the spectrum numbers to plot
+ Cannot be used at the same time as indices
+ """
+ _report_deprecated_parameter("distribution", distribution)
+
+ plot_kwargs = {}
+ if type==1:
+ plot_kwargs["linestyle"] = "None"
+ plot_kwargs["marker"] = "."
+ return plot(_ensure_object_is_list(workspaces), wksp_indices=_ensure_object_is_list(indices),
+ errors=error_bars, spectrum_nums=_ensure_object_is_list(spectrum_nums), waterfall = waterfall,
+ fig=window, overplot=((window is not None) and not clearWindow), plot_kwargs=plot_kwargs)
+
+
+def plotBin(workspaces, indices, error_bars=False, type=None, window=None, clearWindow=None,
+ waterfall=None):
+ """Create a 1D Plot of bin count vs spectrum in a workspace.
+
+ This puts the spectrum number as the X variable, and the
+ count in the particular bin # (in 'indices') as the Y value.
+
+ If indices is a tuple or list, then several curves are created, one
+ for each bin index.
+
+ :param workspace or name of a workspace
+ :param indices: bin number(s) to plot
+ :param error_bars: If true then error bars will be added for each curve
+ :param type: curve style for plot it 1: scatter/dots otherwise line, default
+ :param window:If passed an existing plot then the plot will occur in that plot
+ :param clearWindow: If true, and window set then the plot will be cleared before adding these curves
+ :param waterfall: If true then a waterfall plot will be produced
+
+ """
+
+ plot_kwargs = {"axis": MantidAxType.BIN}
+ if type==1:
+ plot_kwargs["linestyle"] = "None"
+ plot_kwargs["marker"] = "."
+ return plot(_ensure_object_is_list(workspaces), wksp_indices=_ensure_object_is_list(indices),
+ errors=error_bars, plot_kwargs=plot_kwargs, fig = window, waterfall = waterfall,
+ overplot = ((window is not None) and not clearWindow))
+
+
+# -----------------------------------------------------------------------------
+# 'Private' Functions
+# -----------------------------------------------------------------------------
+def _ensure_object_is_list(object):
+ """If the object is not a list itself it will be returned in a list"""
+ if (object is None) or isinstance(object, list):
+ return object
+ else:
+ return [object]
+
+
+def _report_deprecated_parameter(param_name,param_value):
+ """Logs a warning message if the parameter value is not None"""
+ if param_value is not None:
+ LOGGER.warning("The argument '{}' is not supported in workbench and has been ignored".format(param_name))
+
diff --git a/Framework/PythonInterface/mantid/plots/axesfunctions.py b/Framework/PythonInterface/mantid/plots/axesfunctions.py
new file mode 100644
index 0000000000000000000000000000000000000000..42e662fb314c2b5ac0b5c3b19ce8fa39fe29ca39
--- /dev/null
+++ b/Framework/PythonInterface/mantid/plots/axesfunctions.py
@@ -0,0 +1,765 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2017 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+# This file is part of the mantid package
+#
+#
+from __future__ import (absolute_import, division, print_function)
+
+import collections
+import matplotlib
+import matplotlib.collections as mcoll
+import matplotlib.colors
+import matplotlib.dates as mdates
+import matplotlib.image as mimage
+import numpy
+import sys
+
+import mantid.api
+import mantid.kernel
+import mantid.plots.modest_image
+from mantid.plots.datafunctions import get_axes_labels, get_bins, get_data_uneven_flag, get_distribution, \
+ get_matrix_2d_ragged, get_matrix_2d_data, get_md_data1d, get_md_data2d_bin_bounds, \
+ get_md_data2d_bin_centers, get_normalization, get_sample_log, get_spectrum, get_uneven_data, \
+ get_wksp_index_dist_and_label, check_resample_to_regular_grid, get_indices, get_normalize_by_bin_width
+from mantid.plots.utility import MantidAxType
+
+# Used for initializing searches of max, min values
+_LARGEST, _SMALLEST = float(sys.maxsize), -sys.maxsize
+
+
+# ================================================
+# Private 2D Helper functions
+# ================================================
+
+def _setLabels1D(axes, workspace, indices=None, normalize_by_bin_width=True,
+ axis=MantidAxType.SPECTRUM):
+ '''
+ helper function to automatically set axes labels for 1D plots
+ '''
+ labels = get_axes_labels(workspace, indices, normalize_by_bin_width)
+ # We assume that previous checking has ensured axis can only be 1 of 2 types
+ axes.set_xlabel(labels[1 if axis == MantidAxType.SPECTRUM else 2])
+ axes.set_ylabel(labels[0])
+
+
+def _setLabels2D(axes, workspace, indices=None, transpose=False,
+ xscale=None, normalize_by_bin_width=True):
+ '''
+ helper function to automatically set axes labels for 2D plots
+ '''
+ labels = get_axes_labels(workspace, indices, normalize_by_bin_width)
+ if transpose:
+ axes.set_xlabel(labels[2])
+ axes.set_ylabel(labels[1])
+ else:
+ axes.set_xlabel(labels[1])
+ axes.set_ylabel(labels[2])
+ axes.set_title(labels[0])
+ if xscale is None and hasattr(workspace, 'isCommonLogBins') and workspace.isCommonLogBins():
+ axes.set_xscale('log')
+ elif xscale is not None:
+ axes.set_xscale(xscale)
+
+
+def _get_data_for_plot(axes, workspace, kwargs, with_dy=False, with_dx=False):
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ (x, y, dy) = get_md_data1d(workspace, normalization, indices)
+ dx = None
+ axis = None
+ else:
+ axis = MantidAxType(kwargs.pop("axis", MantidAxType.SPECTRUM))
+ normalize_by_bin_width, kwargs = get_normalize_by_bin_width(
+ workspace, axes, **kwargs)
+ workspace_index, distribution, kwargs = get_wksp_index_dist_and_label(workspace, axis, **kwargs)
+ if axis == MantidAxType.BIN:
+ # Overwrite any user specified xlabel
+ axes.set_xlabel("Spectrum")
+ x, y, dy, dx = get_bins(workspace, workspace_index, with_dy)
+ elif axis == MantidAxType.SPECTRUM:
+ x, y, dy, dx = get_spectrum(workspace, workspace_index,
+ normalize_by_bin_width, with_dy, with_dx)
+ else:
+ raise ValueError("Axis {} is not a valid axis number.".format(axis))
+ indices = None
+ return x, y, dy, dx, indices, axis, kwargs
+
+
+# ========================================================
+# Plot functions
+# ========================================================
+
+def _plot_impl(axes, workspace, args, kwargs):
+ """
+ Compute data and labels for plot. Used by workspace
+ replacement handlers to recompute data. See plot for
+ argument details
+ """
+ if 'LogName' in kwargs:
+ (x, y, FullTime, LogName, units, kwargs) = get_sample_log(workspace, **kwargs)
+ axes.set_ylabel('{0} ({1})'.format(LogName, units))
+ axes.set_xlabel('Time (s)')
+ if FullTime:
+ axes.xaxis_date()
+ axes.xaxis.set_major_formatter(mdates.DateFormatter('%H:%M:%S\n%b-%d'))
+ axes.set_xlabel('Time')
+ kwargs['linestyle'] = 'steps-post'
+ else:
+ normalize_by_bin_width, kwargs = get_normalize_by_bin_width(
+ workspace, axes, **kwargs)
+ x, y, _, _, indices, axis, kwargs = _get_data_for_plot(axes, workspace, kwargs)
+ if kwargs.pop('update_axes_labels', True):
+ _setLabels1D(axes, workspace, indices,
+ normalize_by_bin_width=normalize_by_bin_width, axis=axis)
+ kwargs.pop('normalize_by_bin_width', None)
+ return x, y, args, kwargs
+
+
+def plot(axes, workspace, *args, **kwargs):
+ """
+ Unpack mantid workspace and render it with matplotlib. ``args`` and
+ ``kwargs`` are passed to :py:meth:`matplotlib.axes.Axes.plot` after special
+ keyword arguments are removed. This will automatically label the
+ line according to the spectrum number unless specified otherwise.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param specNum: spectrum number to plot if MatrixWorkspace
+ :param wkspIndex: workspace index to plot if MatrixWorkspace
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the workspace is a MatrixWorkspace histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param normalize_by_bin_width: ``None`` (default) ask the workspace. It can override
+ the value from distribution. Is implemented so get_normalize_by_bin_width
+ only need to be run once.
+ :param LogName: if specified, it will plot the corresponding sample log. The x-axis
+ of the plot is the time difference between the log time and the first
+ value of the `proton_charge` log (if available) or the sample log's
+ first time.
+ :param StartFromLog: False by default. If True the time difference will be from the sample log's
+ first time, even if `proton_charge` log is available.
+ :param FullTime: False by default. If true, the full date and time will be plotted on the axis
+ instead of the time difference
+ :param ExperimentInfo: for MD Workspaces with multiple :class:`mantid.api.ExperimentInfo` is the
+ ExperimentInfo object from which to extract the log. It's 0 by default
+ :param axis: Specify which axis will be plotted. Use axis=MantidAxType.BIN to plot a bin,
+ and axis=MantidAxType.SPECTRUM to plot a spectrum.
+ The default value is axis=1, plotting spectra by default.
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimension to plot. *e.g.* to select the second axis to plot from a
+ 3D volume use ``indices=(5, slice(None), 10)`` where the 5/10 are the bins selected
+ for the other 2 axes.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the second
+ axis to plot from a 3D volume use ``slicepoint=(1.0, None, 2.0)`` where the 1.0/2.0 are
+ the dimension selected for the other 2 axes.
+
+ For matrix workspaces with more than one spectra, either ``specNum`` or ``wkspIndex``
+ needs to be specified. Giving both will generate a :class:`RuntimeError`. There is no similar
+ keyword for MDHistoWorkspaces. These type of workspaces have to have exactly one non integrated
+ dimension
+ """
+ x, y, args, kwargs = _plot_impl(axes, workspace, args, kwargs)
+ return axes.plot(x, y, *args, **kwargs)
+
+
+def errorbar(axes, workspace, *args, **kwargs):
+ """
+ Unpack mantid workspace and render it with matplotlib. ``args`` and
+ ``kwargs`` are passed to :py:meth:`matplotlib.axes.Axes.errorbar` after special
+ keyword arguments are removed. This will automatically label the
+ line according to the spectrum number unless specified otherwise.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param specNum: spectrum number to plot if MatrixWorkspace
+ :param wkspIndex: workspace index to plot if MatrixWorkspace
+ :param distribution: ``None`` (default) asks the global setting. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the workspace is a MatrixWorkspace histogram.
+ :param normalize_by_bin_width: Plot the workspace as a distribution. If None default to global
+ setting: config['graph1d.autodistribution']
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param axis: Specify which axis will be plotted. Use axis=MantidAxType.BIN to plot a bin,
+ and axis=MantidAxType.SPECTRUM to plot a spectrum.
+ The default value is axis=1, plotting spectra by default.
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimension to plot. *e.g.* to select the second axis to plot from a
+ 3D volume use ``indices=(5, slice(None), 10)`` where the 5/10 are the bins selected
+ for the other 2 axes.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the second
+ axis to plot from a 3D volume use ``slicepoint=(1.0, None, 2.0)`` where the 1.0/2.0 are
+ the dimension selected for the other 2 axes.
+
+ For matrix workspaces with more than one spectra, either ``specNum`` or ``wkspIndex``
+ needs to be specified. Giving both will generate a :class:`RuntimeError`. There is no similar
+ keyword for MDHistoWorkspaces. These type of workspaces have to have exactly one non integrated
+ dimension
+ """
+ normalize_by_bin_width, kwargs = get_normalize_by_bin_width(
+ workspace, axes, **kwargs)
+ x, y, dy, dx, indices, axis, kwargs = _get_data_for_plot(
+ axes, workspace, kwargs, with_dy=True, with_dx=False)
+ if kwargs.pop('update_axes_labels', True):
+ _setLabels1D(axes, workspace, indices,
+ normalize_by_bin_width=normalize_by_bin_width, axis=axis)
+ kwargs.pop('normalize_by_bin_width', None)
+
+ return axes.errorbar(x, y, dy, dx, *args, **kwargs)
+
+
+def scatter(axes, workspace, *args, **kwargs):
+ '''
+ Unpack mantid workspace and render it with matplotlib. ``args`` and
+ ``kwargs`` are passed to :py:meth:`matplotlib.axes.Axes.scatter` after special
+ keyword arguments are removed. This will automatically label the
+ line according to the spectrum number unless specified otherwise.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param specNum: spectrum number to plot if MatrixWorkspace
+ :param wkspIndex: workspace index to plot if MatrixWorkspace
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the workspace is a MatrixWorkspace histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimension to plot. *e.g.* to select the second axis to plot from a
+ 3D volume use ``indices=(5, slice(None), 10)`` where the 5/10 are the bins selected
+ for the other 2 axes.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the second
+ axis to plot from a 3D volume use ``slicepoint=(1.0, None, 2.0)`` where the 1.0/2.0 are
+ the dimension selected for the other 2 axes.
+
+ For matrix workspaces with more than one spectra, either ``specNum`` or ``wkspIndex``
+ needs to be specified. Giving both will generate a :class:`RuntimeError`. There is no similar
+ keyword for MDHistoWorkspaces. These type of workspaces have to have exactly one non integrated
+ dimension
+ '''
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ (x, y, _) = get_md_data1d(workspace, normalization, indices)
+ _setLabels1D(axes, workspace, indices)
+ else:
+ (wkspIndex, distribution, kwargs) = get_wksp_index_dist_and_label(workspace, **kwargs)
+ (x, y, _, _) = get_spectrum(workspace, wkspIndex, distribution)
+ _setLabels1D(axes, workspace)
+ return axes.scatter(x, y, *args, **kwargs)
+
+
+def contour(axes, workspace, *args, **kwargs):
+ '''
+ Essentially the same as :meth:`matplotlib.axes.Axes.contour`
+ but calculates the countour levels. Currently this only works with
+ workspaces that have a constant number of bins between spectra.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x, y, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose)
+ return axes.contour(x, y, z, *args, **kwargs)
+
+
+def contourf(axes, workspace, *args, **kwargs):
+ '''
+ Essentially the same as :meth:`matplotlib.axes.Axes.contourf`
+ but calculates the countour levels. Currently this only works with
+ workspaces that have a constant number of bins between spectra.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x, y, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose)
+ return axes.contourf(x, y, z, *args, **kwargs)
+
+
+def _pcolorpieces(axes, workspace, distribution, *args, **kwargs):
+ '''
+ Helper function for pcolor, pcolorfast, and pcolormesh that will
+ plot a 2d representation of each spectra. The polycollections or meshes
+ will be normalized to the same intensity limits.
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param pcolortype: this keyword allows the plotting to be one of pcolormesh or
+ pcolorfast if there is "mesh" or "fast" in the value of the keyword, or
+ pcolor by default
+ :return: A list of the pcolor pieces created
+ '''
+ (x, y, z) = get_uneven_data(workspace, distribution)
+ mini = numpy.min([numpy.min(i) for i in z])
+ maxi = numpy.max([numpy.max(i) for i in z])
+ if 'vmin' in kwargs:
+ mini = kwargs['vmin']
+ if 'vmax' in kwargs:
+ maxi = kwargs['vmax']
+ if 'norm' not in kwargs:
+ kwargs['norm'] = matplotlib.colors.Normalize(vmin=mini, vmax=maxi)
+ else:
+ if kwargs['norm'].vmin is None:
+ kwargs['norm'].vmin = mini
+ if kwargs['norm'].vmax is None:
+ kwargs['norm'].vmax = maxi
+
+ # setup the particular pcolor to use
+ pcolortype = kwargs.pop('pcolortype', '').lower()
+ if 'mesh' in pcolortype:
+ pcolor = axes.pcolormesh
+ elif 'fast' in pcolortype:
+ pcolor = axes.pcolorfast
+ else:
+ pcolor = axes.pcolor
+
+ pieces = []
+ for xi, yi, zi in zip(x, y, z):
+ XX, YY = numpy.meshgrid(xi, yi, indexing='ij')
+ pieces.append(pcolor(XX, YY, zi.reshape(-1, 1), **kwargs))
+
+ return pieces
+
+
+def pcolor(axes, workspace, *args, **kwargs):
+ '''
+ Essentially the same as :meth:`matplotlib.axes.Axes.pcolor`
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param axisaligned: ``False`` (default). If ``True``, or if the workspace has a variable
+ number of bins, the polygons will be aligned with the axes
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x, y, z = get_md_data2d_bin_bounds(workspace, normalization, indices, transpose)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (aligned, kwargs) = check_resample_to_regular_grid(workspace, **kwargs)
+ (normalize_by_bin_width, kwargs) = get_normalize_by_bin_width(workspace, axes, **kwargs)
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ if aligned:
+ kwargs['pcolortype'] = ''
+ return _pcolorpieces(axes, workspace, distribution, *args, **kwargs)
+ else:
+ (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=True, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose, normalize_by_bin_width=normalize_by_bin_width)
+ return axes.pcolor(x, y, z, *args, **kwargs)
+
+
+def pcolorfast(axes, workspace, *args, **kwargs):
+ '''
+ Essentially the same as :meth:`matplotlib.axes.Axes.pcolorfast`
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param axisaligned: ``False`` (default). If ``True``, or if the workspace has a variable
+ number of bins, the polygons will be aligned with the axes
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x, y, z = get_md_data2d_bin_bounds(workspace, normalization, indices, transpose)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (aligned, kwargs) = check_resample_to_regular_grid(workspace, **kwargs)
+ (normalize_by_bin_width, kwargs) = get_normalize_by_bin_width(workspace, axes, **kwargs)
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ if aligned:
+ kwargs['pcolortype'] = 'fast'
+ return _pcolorpieces(axes, workspace, distribution, *args, **kwargs)
+ else:
+ (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=True, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose, normalize_by_bin_width=normalize_by_bin_width)
+ return axes.pcolorfast(x, y, z, *args, **kwargs)
+
+
+def pcolormesh(axes, workspace, *args, **kwargs):
+ '''
+ Essentially the same as :meth:`matplotlib.axes.Axes.pcolormesh`.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param axisaligned: ``False`` (default). If ``True``, or if the workspace has a variable
+ number of bins, the polygons will be aligned with the axes
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x, y, z = get_md_data2d_bin_bounds(workspace, normalization, indices, transpose)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (aligned, kwargs) = check_resample_to_regular_grid(workspace, **kwargs)
+ (normalize_by_bin_width, kwargs) = get_normalize_by_bin_width(workspace, axes, **kwargs)
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ if aligned:
+ kwargs['pcolortype'] = 'mesh'
+ return _pcolorpieces(axes, workspace, distribution, *args, **kwargs)
+ else:
+ (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=True, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose, normalize_by_bin_width=normalize_by_bin_width)
+ return axes.pcolormesh(x, y, z, *args, **kwargs)
+
+
+def imshow(axes, workspace, *args, **kwargs):
+ '''
+ Essentially the same as :meth:`matplotlib.axes.Axes.imshow`.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param axisaligned: ``False`` (default). If ``True``, or if the workspace has a variable
+ number of bins, the polygons will be aligned with the axes
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x, y, z = get_md_data2d_bin_bounds(workspace, normalization, indices, transpose)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (aligned, kwargs) = check_resample_to_regular_grid(workspace, **kwargs)
+ (normalize_by_bin_width, kwargs) = get_normalize_by_bin_width(workspace, axes, **kwargs)
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ if aligned:
+ (x, y, z) = get_matrix_2d_ragged(workspace, normalize_by_bin_width, histogram2D=True, transpose=transpose)
+ else:
+ (x, y, z) = get_matrix_2d_data(workspace, distribution=distribution, histogram2D=True, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose, normalize_by_bin_width=normalize_by_bin_width)
+ if 'extent' not in kwargs:
+ if x.ndim == 2 and y.ndim == 2:
+ kwargs['extent'] = [x[0, 0], x[0, -1], y[0, 0], y[-1, 0]]
+ else:
+ kwargs['extent'] = [x[0], x[-1], y[0], y[-1]]
+ return mantid.plots.modest_image.imshow(axes, z, *args, **kwargs)
+
+
+def tripcolor(axes, workspace, *args, **kwargs):
+ '''
+ To be used with non-uniform grids. Currently this only works with workspaces
+ that have a constant number of bins between spectra or with
+ MDHistoWorkspaces.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+
+ See :meth:`matplotlib.axes.Axes.tripcolor` for more information.
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x_temp, y_temp, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
+ x, y = numpy.meshgrid(x_temp, y_temp)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose)
+ return axes.tripcolor(x.ravel(), y.ravel(), z.ravel(), *args, **kwargs)
+
+
+def tricontour(axes, workspace, *args, **kwargs):
+ '''
+ Essentially the same as :meth:`mantid.plots.contour`, but works
+ for non-uniform grids. Currently this only works with workspaces
+ that have a constant number of bins between spectra or with
+ MDHistoWorkspaces.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+
+ See :meth:`matplotlib.axes.Axes.tricontour` for more information.
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x_temp, y_temp, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
+ x, y = numpy.meshgrid(x_temp, y_temp)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose)
+ # tricontour segfaults if many z values are not finite
+ # https://github.com/matplotlib/matplotlib/issues/10167
+ x = x.ravel()
+ y = y.ravel()
+ z = z.ravel()
+ condition = numpy.isfinite(z)
+ x = x[condition]
+ y = y[condition]
+ z = z[condition]
+ return axes.tricontour(x, y, z, *args, **kwargs)
+
+
+def tricontourf(axes, workspace, *args, **kwargs):
+ '''
+ Essentially the same as :meth:`mantid.plots.contourf`, but works
+ for non-uniform grids. Currently this only works with workspaces
+ that have a constant number of bins between spectra or with
+ MDHistoWorkspaces.
+
+ :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
+ :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
+ to extract the data from
+ :param distribution: ``None`` (default) asks the workspace. ``False`` means
+ divide by bin width. ``True`` means do not divide by bin width.
+ Applies only when the the matrix workspace is a histogram.
+ :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
+ the value from displayNormalizationHisto. It checks only if
+ the normalization is mantid.api.MDNormalization.NumEventsNormalization
+ :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
+ and will be interpreted as a list of indices. You need to use ``slice(None)`` to
+ select which dimensions to plot. *e.g.* to select the last two axes to plot from a
+ 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
+ for the first axis.
+ :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
+ You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
+ two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
+ the value of the dimension selected for the first axis.
+ :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
+
+ See :meth:`matplotlib.axes.Axes.tricontourf` for more information.
+ '''
+ transpose = kwargs.pop('transpose', False)
+ if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
+ (normalization, kwargs) = get_normalization(workspace, **kwargs)
+ indices, kwargs = get_indices(workspace, **kwargs)
+ x_temp, y_temp, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
+ x, y = numpy.meshgrid(x_temp, y_temp)
+ _setLabels2D(axes, workspace, indices, transpose)
+ else:
+ (distribution, kwargs) = get_distribution(workspace, **kwargs)
+ (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
+ _setLabels2D(axes, workspace, transpose=transpose)
+ # tricontourf segfaults if many z values are not finite
+ # https://github.com/matplotlib/matplotlib/issues/10167
+ x = x.ravel()
+ y = y.ravel()
+ z = z.ravel()
+ condition = numpy.isfinite(z)
+ x = x[condition]
+ y = y[condition]
+ z = z[condition]
+ return axes.tricontourf(x, y, z, *args, **kwargs)
+
+
+def update_colorplot_datalimits(axes, mappables):
+ """
+ For an colorplot (imshow, pcolor*) plots update the data limits on the axes
+ to circumvent bugs in matplotlib
+ :param mappables: An iterable of mappable for this axes
+ """
+ # ax.relim in matplotlib < 2.2 doesn't take into account of images
+ # and it doesn't support collections at all as of verison 3 so we'll take
+ # over
+ if not isinstance(mappables, collections.Iterable):
+ mappables = [mappables]
+ xmin_all, xmax_all, ymin_all, ymax_all = _LARGEST, _SMALLEST, _LARGEST, _SMALLEST
+ for mappable in mappables:
+ xmin, xmax, ymin, ymax = get_colorplot_extents(mappable)
+ xmin_all, xmax_all = min(xmin_all, xmin), max(xmax_all, xmax)
+ ymin_all, ymax_all = min(ymin_all, ymin), max(ymax_all, ymax)
+ axes.update_datalim(((xmin_all, ymin_all), (xmax_all, ymax_all)))
+ axes.autoscale()
+
+
+def get_colorplot_extents(mappable):
+ """
+ Return the extent of the given mappable
+ :param mappable: A 2D mappable object
+ :return: (left, right, bottom, top)
+ """
+ if isinstance(mappable, mimage.AxesImage):
+ xmin, xmax, ymin, ymax = mappable.get_extent()
+ elif isinstance(mappable, mcoll.QuadMesh):
+ # coordinates are vertices of the grid
+ coords = mappable._coordinates
+ xmin, ymin = coords[0][0]
+ xmax, ymax = coords[-1][-1]
+ elif isinstance(mappable, mcoll.PolyCollection):
+ xmin, ymin = mappable._paths[0].get_extents().min
+ xmax, ymax = mappable._paths[-1].get_extents().max
+ else:
+ raise ValueError("Unknown mappable type '{}'".format(type(mappable)))
+
+ return xmin, xmax, ymin, ymax
diff --git a/Framework/PythonInterface/mantid/plots/plotfunctions3D.py b/Framework/PythonInterface/mantid/plots/axesfunctions3D.py
similarity index 97%
rename from Framework/PythonInterface/mantid/plots/plotfunctions3D.py
rename to Framework/PythonInterface/mantid/plots/axesfunctions3D.py
index 8576d3ab8cd673d42c02149d4b8181451e66bd96..84822b5dd530e0088d3d889b25a800eaa55df550 100644
--- a/Framework/PythonInterface/mantid/plots/plotfunctions3D.py
+++ b/Framework/PythonInterface/mantid/plots/axesfunctions3D.py
@@ -11,9 +11,9 @@ from __future__ import (absolute_import, division, print_function)
import numpy
-from mantid.plots.helperfunctions import (get_axes_labels, get_normalization, get_distribution,
- get_md_data2d_bin_centers, get_matrix_2d_data, get_md_data1d,
- get_wksp_index_dist_and_label, get_spectrum, get_indices)
+from mantid.plots.datafunctions import (get_axes_labels, get_normalization, get_distribution,
+ get_md_data2d_bin_centers, get_matrix_2d_data, get_md_data1d,
+ get_wksp_index_dist_and_label, get_spectrum, get_indices)
import mantid.dataobjects
diff --git a/Framework/PythonInterface/mantid/plots/helperfunctions.py b/Framework/PythonInterface/mantid/plots/datafunctions.py
similarity index 99%
rename from Framework/PythonInterface/mantid/plots/helperfunctions.py
rename to Framework/PythonInterface/mantid/plots/datafunctions.py
index a07228d9696f41cebe9f0c5016dac040992d595e..494e7fbcd406c564941ecabac446c4795eae2da6 100644
--- a/Framework/PythonInterface/mantid/plots/helperfunctions.py
+++ b/Framework/PythonInterface/mantid/plots/datafunctions.py
@@ -27,7 +27,7 @@ from mantid.plots.utility import MantidAxType
# Helper functions for data extraction from a Mantid workspace and plot functionality
-# These functions are common between plotfunctions.py and plotfunctions3D.py
+# These functions are common between axesfunctions.py and axesfunctions3D.py
# ====================================================
# Validation
@@ -431,7 +431,7 @@ def get_matrix_2d_ragged(workspace, normalize_by_bin_width, histogram2D=False, t
xtmp = workspace.readX(i)
if workspace.isHistogramData():
# input x is edges
- xtmp = mantid.plots.helperfunctions.points_from_boundaries(xtmp)
+ xtmp = mantid.plots.datafunctions.points_from_boundaries(xtmp)
else:
# input x is centers
pass
@@ -441,15 +441,15 @@ def get_matrix_2d_ragged(workspace, normalize_by_bin_width, histogram2D=False, t
delta = min(delta, diff.min())
num_edges = int(np.ceil((max_value - min_value)/delta)) + 1
x_centers = np.linspace(min_value, max_value, num=num_edges)
- y = mantid.plots.helperfunctions.boundaries_from_points(workspace.getAxis(1).extractValues())
+ y = mantid.plots.datafunctions.boundaries_from_points(workspace.getAxis(1).extractValues())
z = np.empty([num_hist, num_edges], dtype=np.float64)
for i in range(num_hist):
- centers, ztmp, _, _ = mantid.plots.helperfunctions.get_spectrum(
+ centers, ztmp, _, _ = mantid.plots.datafunctions.get_spectrum(
workspace, i, normalize_by_bin_width=normalize_by_bin_width, withDy=False, withDx=False)
f = interp1d(centers, ztmp, kind='nearest', bounds_error=False, fill_value=np.nan)
z[i] = f(x_centers)
if histogram2D:
- x = mantid.plots.helperfunctions.boundaries_from_points(x_centers)
+ x = mantid.plots.datafunctions.boundaries_from_points(x_centers)
else:
x = x_centers
if transpose:
diff --git a/Framework/PythonInterface/mantid/plots/mantidaxes.py b/Framework/PythonInterface/mantid/plots/mantidaxes.py
new file mode 100644
index 0000000000000000000000000000000000000000..b586e398cb0f1e9d2f3f7013f60854f12b94822e
--- /dev/null
+++ b/Framework/PythonInterface/mantid/plots/mantidaxes.py
@@ -0,0 +1,1377 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2017 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+# This file is part of the mantid package
+from __future__ import absolute_import
+
+try:
+ from collections.abc import Iterable
+except ImportError:
+ # check Python 2 location
+ from collections import Iterable
+
+from matplotlib.axes import Axes
+from matplotlib.collections import Collection, PolyCollection
+from matplotlib.colors import Colormap
+from matplotlib.container import Container, ErrorbarContainer
+from matplotlib.image import AxesImage
+from matplotlib.lines import Line2D
+from matplotlib.patches import Patch
+from matplotlib.table import Table
+from mpl_toolkits.mplot3d import Axes3D
+
+from mantid import logger
+from mantid.api import AnalysisDataService as ads
+from mantid.plots import datafunctions, axesfunctions, axesfunctions3D
+from mantid.plots.legend import LegendProperties
+from mantid.plots.datafunctions import get_normalize_by_bin_width
+from mantid.plots.utility import (artists_hidden, autoscale_on_update,
+ legend_set_draggable, MantidAxType)
+
+
+WATERFALL_XOFFSET_DEFAULT, WATERFALL_YOFFSET_DEFAULT = 10, 20
+
+# -----------------------------------------------------------------------------
+# Decorators
+# -----------------------------------------------------------------------------
+def plot_decorator(func):
+ def wrapper(self, *args, **kwargs):
+ func_value = func(self, *args, **kwargs)
+ # Saves saving it on array objects
+ if datafunctions.validate_args(*args, **kwargs):
+ # Fill out kwargs with the values of args
+ kwargs["workspaces"] = args[0].name()
+ kwargs["function"] = func.__name__
+
+ if 'wkspIndex' not in kwargs and 'specNum' not in kwargs:
+ kwargs['specNum'] = MantidAxes.get_spec_number_or_bin(args[0], kwargs)
+ if "cmap" in kwargs and isinstance(kwargs["cmap"], Colormap):
+ kwargs["cmap"] = kwargs["cmap"].name
+ self.creation_args.append(kwargs)
+ return func_value
+
+ return wrapper
+
+# -----------------------------------------------------------------------------
+# MantidAxes
+# -----------------------------------------------------------------------------
+class MantidAxes(Axes):
+ """
+ This class defines the **mantid** projection for 2d plotting. One chooses
+ this projection using::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+
+ or::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+ fig = plt.figure()
+ ax = fig.add_subplot(111,projection='mantid')
+
+ The mantid projection allows replacing the array objects with mantid workspaces.
+ """
+ # Required by Axes base class
+ name = 'mantid'
+
+ # Store information for any workspaces attached to this axes instance
+ tracked_workspaces = None
+
+ def __init__(self, *args, **kwargs):
+ super(MantidAxes, self).__init__(*args, **kwargs)
+ self.tracked_workspaces = dict()
+ self.creation_args = []
+ self.interactive_markers = []
+ # flag to indicate if a function has been set to replace data
+ self.data_replaced = False
+
+ self.waterfall_x_offset = 0
+ self.waterfall_y_offset = 0
+
+ def add_artist_correctly(self, artist):
+ """
+ Add an artist via the correct function.
+ MantidAxes will not correctly track artists added via :code:`add_artist`.
+ They must be added via the correct function for features like
+ autoscaling to work.
+
+ :param artist: A Matplotlib Artist object
+ """
+ artist.set_transform(self.transData)
+ if artist.axes:
+ artist.remove()
+ if isinstance(artist, Line2D):
+ self.add_line(artist)
+ elif isinstance(artist, Collection):
+ self.add_collection(artist)
+ elif isinstance(artist, Container):
+ self.add_container(artist)
+ elif isinstance(artist, AxesImage):
+ self.add_image(artist)
+ elif isinstance(artist, Patch):
+ self.add_patch(artist)
+ elif isinstance(artist, Table):
+ self.add_table(artist)
+ else:
+ self.add_artist(artist)
+
+ @staticmethod
+ def from_mpl_axes(ax, ignore_artists=None):
+ """
+ Returns a MantidAxes from an Axes object.
+ Transfers all transferable artists from a Matplotlib.Axes
+ instance to a MantidAxes instance on the same figure. Then
+ removes the Matplotlib.Axes.
+
+ :param ax: An Axes object
+ :param ignore_artists: List of Artist types to ignore
+ :returns: A MantidAxes object
+ """
+ if not ignore_artists:
+ ignore_artists = []
+ prop_cycler = ax._get_lines.prop_cycler # tracks line color cycle
+ artists = ax.get_children()
+ mantid_axes = ax.figure.add_subplot(111, projection='mantid', label='mantid')
+ for artist in artists:
+ if not any(isinstance(artist, artist_type) for artist_type in ignore_artists):
+ try:
+ mantid_axes.add_artist_correctly(artist)
+ except NotImplementedError:
+ pass
+ mantid_axes.set_title(ax.get_title())
+ mantid_axes._get_lines.prop_cycler = prop_cycler
+ ax.remove()
+ return mantid_axes
+
+ @staticmethod
+ def is_axis_of_type(axis_type, kwargs):
+ if kwargs.get('axis', None) is not None:
+ return kwargs.get('axis', None) == axis_type
+ return axis_type == MantidAxType.SPECTRUM
+
+ @staticmethod
+ def get_spec_num_from_wksp_index(workspace, wksp_index):
+ return workspace.getSpectrum(wksp_index).getSpectrumNo()
+
+ @staticmethod
+ def get_spec_number_or_bin(workspace, kwargs):
+ if kwargs.get('specNum', None) is not None:
+ return kwargs['specNum']
+ elif kwargs.get('wkspIndex', None) is not None:
+ # If wanting to plot a bin
+ if MantidAxes.is_axis_of_type(MantidAxType.BIN, kwargs):
+ return kwargs['wkspIndex']
+ # If wanting to plot a spectrum
+ elif MantidAxes.is_axis_of_type(MantidAxType.SPECTRUM, kwargs):
+ return MantidAxes.get_spec_num_from_wksp_index(workspace, kwargs['wkspIndex'])
+ elif kwargs.get('LogName', None) is not None:
+ return None
+ elif getattr(workspace, 'getNumberHistograms', lambda: -1)() == 1:
+ # If the workspace has one histogram, just plot that
+ kwargs['wkspIndex'] = 0
+ if MantidAxes.is_axis_of_type(MantidAxType.BIN, kwargs):
+ return kwargs['wkspIndex']
+ return MantidAxes.get_spec_num_from_wksp_index(workspace, kwargs['wkspIndex'])
+ else:
+ return None
+
+ def get_workspace_name_from_artist(self, artist):
+ for ws_name, ws_artists_list in self.tracked_workspaces.items():
+ for ws_artists in ws_artists_list:
+ for ws_artist in ws_artists._artists:
+ if artist == ws_artist:
+ return ws_name
+
+ def get_artists_workspace_and_spec_num(self, artist):
+ """Retrieve the workspace and spec num of the given artist"""
+ for ws_name, ws_artists_list in self.tracked_workspaces.items():
+ for ws_artists in ws_artists_list:
+ for ws_artist in ws_artists._artists:
+ if artist == ws_artist:
+ return ads.retrieve(ws_name), ws_artists.spec_num
+ raise ValueError("Artist: '{}' not tracked by axes.".format(artist))
+
+ def get_artist_normalization_state(self, artist):
+ for ws_name, ws_artists_list in self.tracked_workspaces.items():
+ for ws_artists in ws_artists_list:
+ for ws_artist in ws_artists._artists:
+ if artist == ws_artist:
+ return ws_artists.is_normalized
+
+ def track_workspace_artist(self,
+ workspace,
+ artists,
+ data_replace_cb=None,
+ spec_num=None,
+ is_normalized=None,
+ is_spec=True):
+ """
+ Add the given workspace's name to the list of workspaces
+ displayed on this Axes instance
+ :param workspace: A Workspace object. If empty then no tracking takes place
+ :param artists: A single artist or iterable of artists containing the data for the workspace
+ :param data_replace_cb: A function to call when the data is replaced to update
+ the artist (optional)
+ :param spec_num: The spectrum number associated with the artist (optional)
+ :param is_normalized: bool. The line being plotted is normalized by bin width
+ This can be from either a distribution workspace or a workspace being
+ plotted as a distribution
+ :param is_spec: bool. True if spec_num represents a spectrum, and False if it is a bin index
+ :returns: The artists variable as it was passed in.
+ """
+ name = workspace.name()
+ if name:
+ if data_replace_cb is None:
+ def data_replace_cb(*args):
+ logger.warning("Updating data on this plot type is not yet supported")
+ else:
+ self.data_replaced = True
+
+ artist_info = self.tracked_workspaces.setdefault(name, [])
+
+ artist_info.append(
+ _WorkspaceArtists(artists, data_replace_cb, is_normalized, name, spec_num, is_spec))
+ self.check_axes_distribution_consistency()
+ return artists
+
+ def check_axes_distribution_consistency(self):
+ """
+ Checks if the curves on the axes are all normalized or all
+ non-normalized and displays a warning if not.
+ """
+ tracked_ws_distributions = []
+ for artists in self.tracked_workspaces.values():
+ for artist in artists:
+ if artist.is_normalized is not None:
+ tracked_ws_distributions.append(artist.is_normalized)
+
+ if len(tracked_ws_distributions) > 0:
+ num_normalized = sum(tracked_ws_distributions)
+ if not (num_normalized == 0 or num_normalized == len(tracked_ws_distributions)):
+ logger.warning("You are overlaying distribution and non-distribution data!")
+
+ def artists_workspace_has_errors(self, artist):
+ """Check if the given artist's workspace has errors"""
+ if artist not in self.get_tracked_artists():
+ raise ValueError("Artist '{}' is not tracked and so does not have "
+ "an associated workspace.".format(artist))
+ workspace, spec_num = self.get_artists_workspace_and_spec_num(artist)
+ if artist.axes.creation_args[0].get('axis', None) == MantidAxType.BIN:
+ if any([workspace.readE(i)[spec_num] != 0 for i in range(0, workspace.getNumberHistograms())]):
+ return True
+ else:
+ workspace_index = workspace.getIndexFromSpectrumNumber(spec_num)
+ if any(workspace.readE(workspace_index) != 0):
+ return True
+ return False
+
+ def get_tracked_artists(self):
+ """Get the Matplotlib artist objects that are tracked"""
+ tracked_artists = []
+ for ws_artists_list in self.tracked_workspaces.values():
+ for ws_artists in ws_artists_list:
+ for artist in ws_artists._artists:
+ tracked_artists.append(artist)
+ return tracked_artists
+
+ def remove_workspace_artists(self, workspace):
+ """
+ Remove the artists reference by this workspace (if any) and return True
+ if the axes is then empty
+ :param workspace: A Workspace object
+ :return: True if the axes is empty, false if artists remain or this workspace is not associated here
+ """
+ try:
+ # pop to ensure we don't hold onto an artist reference
+ artist_info = self.tracked_workspaces.pop(workspace.name())
+ except KeyError:
+ return False
+
+ for workspace_artist in artist_info:
+ workspace_artist.remove(self)
+
+ return self.is_empty(self)
+
+ def remove_artists_if(self, unary_predicate):
+ """
+ Remove any artists which satisfy the predicate and return True
+ if the axes is then empty
+ :param unary_predicate: A predicate taking a single matplotlib artist object
+ :return: True if the axes is empty, false if artists remain
+ """
+ is_empty_list = []
+ for workspace_name, artist_info in self.tracked_workspaces.items():
+ is_empty = self._remove_artist_info_if(artist_info, unary_predicate)
+ if is_empty:
+ is_empty_list.append(workspace_name)
+
+ for workspace_name in is_empty_list:
+ self.tracked_workspaces.pop(workspace_name)
+
+ # Catch any artists that are not tracked
+ for artist in self.artists + self.lines + self.containers + self.images:
+ if unary_predicate(artist):
+ artist.remove()
+ if isinstance(artist, ErrorbarContainer):
+ self.containers.remove(artist)
+
+ return self.is_empty(self)
+
+ def _remove_artist_info_if(self, artist_info, unary_predicate):
+ """
+ Remove any artists which satisfy the predicate from the artist_info_list
+ :param artist_info: A list of _WorkspaceArtists objects
+ :param unary_predicate: A predicate taking a single matplotlib artist object
+ :return: True if the artist_info is empty, false if artist_info remain
+ """
+ is_empty_list = [workspace_artist.remove_if(self, unary_predicate) for workspace_artist in artist_info]
+
+ for index, empty in reversed(list(enumerate(is_empty_list))):
+ if empty:
+ artist_info.pop(index)
+
+ return len(artist_info) == 0
+
+ def replace_workspace_artists(self, workspace):
+ """
+ Replace the data of any artists relating to this workspace.
+ The axes are NOT redrawn
+ :param workspace: The workspace containing the new data
+ :return : True if data was replaced, false otherwise
+ """
+ try:
+ artist_info = self.tracked_workspaces[workspace.name()]
+ except KeyError:
+ return False
+
+ is_empty_list = [workspace_artist.replace_data(workspace) for workspace_artist in artist_info]
+
+ for index, empty in reversed(list(enumerate(is_empty_list))):
+ if empty:
+ artist_info.pop(index)
+
+ return True
+
+ def replot_artist(self, artist, errorbars=False, **kwargs):
+ """
+ Replot an artist with a new set of kwargs via 'plot' or 'errorbar'
+ :param artist: The artist to replace
+ :param errorbars: Plot with or without errorbars
+ :returns: The new artist that has been plotted
+ For keywords related to workspaces, see :func:`plotfunctions.plot` or
+ :func:`plotfunctions.errorbar`
+ """
+ kwargs['distribution'] = not self.get_artist_normalization_state(artist)
+ workspace, spec_num = self.get_artists_workspace_and_spec_num(artist)
+ self.remove_artists_if(lambda art: art == artist)
+ if kwargs.get('axis', None) == MantidAxType.BIN:
+ workspace_index = spec_num
+ else:
+ workspace_index = workspace.getIndexFromSpectrumNumber(spec_num)
+ self._remove_matching_curve_from_creation_args(workspace.name(), workspace_index, spec_num)
+
+ if errorbars:
+ new_artist = self.errorbar(workspace, wkspIndex=workspace_index, **kwargs)
+ else:
+ new_artist = self.plot(workspace, wkspIndex=workspace_index, **kwargs)
+ return new_artist
+
+ def relim(self, visible_only=True):
+ # Hiding the markers during the the relim ensures they are not factored
+ # in (assuming that visible_only is True)
+ with artists_hidden(self.interactive_markers):
+ Axes.relim(self, visible_only) # relim on any non-errorbar objects
+ lower_xlim, lower_ylim = self.dataLim.get_points()[0]
+ upper_xlim, upper_ylim = self.dataLim.get_points()[1]
+ for container in self.containers:
+ if isinstance(container, ErrorbarContainer) and (
+ (visible_only and not datafunctions.errorbars_hidden(container))
+ or not visible_only):
+ min_x, max_x, min_y, max_y = datafunctions.get_errorbar_bounds(container)
+ lower_xlim = min(lower_xlim, min_x) if min_x else lower_xlim
+ upper_xlim = max(upper_xlim, max_x) if max_x else upper_xlim
+ lower_ylim = min(lower_ylim, min_y) if min_y else lower_ylim
+ upper_ylim = max(upper_ylim, max_y) if max_y else upper_ylim
+
+ xys = [[lower_xlim, lower_ylim], [upper_xlim, upper_ylim]]
+ # update_datalim will update limits with union of current lims and xys
+ self.update_datalim(xys)
+
+ def make_legend(self):
+ if self.legend_ is None:
+ legend_set_draggable(self.legend(), True)
+ else:
+ props = LegendProperties.from_legend(self.legend_)
+ LegendProperties.create_legend(props, self)
+
+ @staticmethod
+ def is_empty(axes):
+ """
+ Checks the known artist containers to see if anything exists within them
+ :return: True if no artists exist, false otherwise
+ """
+ def _empty(container):
+ return len(container) == 0
+
+ return (_empty(axes.lines) and _empty(axes.images) and _empty(axes.collections)
+ and _empty(axes.containers))
+
+ def twinx(self):
+ """
+ Create a twin Axes sharing the xaxis
+
+ Create a new Axes instance with an invisible x-axis and an independent
+ y-axis positioned opposite to the original one (i.e. at right). The
+ x-axis autoscale setting will be inherited from the original Axes.
+ To ensure that the tick marks of both y-axes align, see
+ `~matplotlib.ticker.LinearLocator`
+
+ Returns
+ -------
+ ax_twin : Axes
+ The newly created Axes instance
+
+ Notes
+ -----
+ For those who are 'picking' artists while using twinx, pick
+ events are only called for the artists in the top-most axes.
+ """
+ ax2 = self._make_twin_axes(sharex=self, projection='mantid')
+ ax2.yaxis.tick_right()
+ ax2.yaxis.set_label_position('right')
+ ax2.yaxis.set_offset_position('right')
+ ax2.set_autoscalex_on(self.get_autoscalex_on())
+ self.yaxis.tick_left()
+ ax2.xaxis.set_visible(False)
+ ax2.patch.set_visible(False)
+ return ax2
+
+ def twiny(self):
+ """
+ Create a twin Axes sharing the yaxis
+
+ Create a new Axes instance with an invisible y-axis and an independent
+ x-axis positioned opposite to the original one (i.e. at top). The
+ y-axis autoscale setting will be inherited from the original Axes.
+ To ensure that the tick marks of both x-axes align, see
+ `~matplotlib.ticker.LinearLocator`
+
+ Returns
+ -------
+ ax_twin : Axes
+ The newly created Axes instance
+
+ Notes
+ -----
+ For those who are 'picking' artists while using twiny, pick
+ events are only called for the artists in the top-most axes.
+ """
+ ax2 = self._make_twin_axes(sharey=self, projection='mantid')
+ ax2.xaxis.tick_top()
+ ax2.xaxis.set_label_position('top')
+ ax2.set_autoscaley_on(self.get_autoscaley_on())
+ self.xaxis.tick_bottom()
+ ax2.yaxis.set_visible(False)
+ ax2.patch.set_visible(False)
+ return ax2
+
+ @plot_decorator
+ def plot(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.plot` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.plot(workspace,'rs',specNum=1) #for workspaces
+ ax.plot(x,y,'bo') #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.plot`.
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions')
+
+ autoscale_on = kwargs.pop("autoscale_on_update", self.get_autoscale_on())
+
+ def _data_update(artists, workspace, new_kwargs=None):
+ # It's only possible to plot 1 line at a time from a workspace
+ try:
+ if new_kwargs:
+ x, y, _, _ = axesfunctions._plot_impl(self, workspace, args, new_kwargs)
+ else:
+ x, y, _, _ = axesfunctions._plot_impl(self, workspace, args, kwargs)
+ artists[0].set_data(x, y)
+ except RuntimeError as ex:
+ # if curve couldn't be plotted then remove it - can happen if the workspace doesn't contain the
+ # spectrum any more following execution of an algorithm
+ logger.information('Curve not plotted: {0}'.format(ex.args[0]))
+
+ # remove the curve using similar to logic that in _WorkspaceArtists._remove
+ artists[0].remove()
+
+ # blank out list that will be returned
+ artists = []
+
+ # also remove the curve from the legend
+ if (not self.is_empty(self)) and self.legend_ is not None:
+ legend_set_draggable(self.legend(), True)
+
+ if new_kwargs:
+ _autoscale_on = new_kwargs.pop("autoscale_on_update", self.get_autoscale_on())
+ else:
+ _autoscale_on = self.get_autoscale_on()
+
+ if _autoscale_on:
+ self.relim()
+ self.autoscale()
+ return artists
+
+ workspace = args[0]
+ spec_num = self.get_spec_number_or_bin(workspace, kwargs)
+ normalize_by_bin_width, kwargs = get_normalize_by_bin_width(workspace, self, **kwargs)
+ is_normalized = normalize_by_bin_width or workspace.isDistribution()
+
+ with autoscale_on_update(self, autoscale_on):
+ artist = self.track_workspace_artist(workspace,
+ axesfunctions.plot(self, normalize_by_bin_width = is_normalized,
+ *args, **kwargs),
+ _data_update, spec_num, is_normalized,
+ MantidAxes.is_axis_of_type(MantidAxType.SPECTRUM, kwargs))
+ return artist
+ else:
+ return Axes.plot(self, *args, **kwargs)
+
+ @plot_decorator
+ def scatter(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.scatter` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.scatter(workspace,'rs',specNum=1) #for workspaces
+ ax.scatter(x,y,'bo') #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.scatter`
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions')
+ else:
+ return Axes.scatter(self, *args, **kwargs)
+
+ @plot_decorator
+ def errorbar(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.errorbar` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.errorbar(workspace,'rs',specNum=1) #for workspaces
+ ax.errorbar(x,y,yerr,'bo') #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.errorbar`
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions')
+
+ autoscale_on = kwargs.pop("autoscale_on_update", self.get_autoscale_on())
+
+ def _data_update(artists, workspace, new_kwargs=None):
+ if new_kwargs:
+ _autoscale_on = new_kwargs.pop("autoscale_on_update", self.get_autoscale_on())
+ else:
+ _autoscale_on = self.get_autoscale_on()
+ # errorbar with workspaces can only return a single container
+ container_orig = artists[0]
+ # It is not possible to simply reset the error bars so
+ # we have to plot new lines but ensure we don't reorder them on the plot!
+ orig_idx = self.containers.index(container_orig)
+ container_orig.remove()
+ # The container does not remove itself from the containers list
+ # but protect this just in case matplotlib starts doing this
+ try:
+ self.containers.remove(container_orig)
+ except ValueError:
+ pass
+ # this gets pushed back onto the containers list
+ try:
+ with autoscale_on_update(self, _autoscale_on):
+ # this gets pushed back onto the containers list
+ if new_kwargs:
+ container_new = axesfunctions.errorbar(self, workspace, **new_kwargs)
+ else:
+ container_new = axesfunctions.errorbar(self, workspace, **kwargs)
+
+ self.containers.insert(orig_idx, container_new)
+ self.containers.pop()
+ # Update joining line
+ if container_new[0] and container_orig[0]:
+ container_new[0].update_from(container_orig[0])
+ # Update caps
+ for orig_caps, new_caps in zip(container_orig[1], container_new[1]):
+ new_caps.update_from(orig_caps)
+ # Update bars
+ for orig_bars, new_bars in zip(container_orig[2], container_new[2]):
+ new_bars.update_from(orig_bars)
+ # Re-plotting in the config dialog will assign this attr
+ if hasattr(container_orig, 'errorevery'):
+ setattr(container_new, 'errorevery', container_orig.errorevery)
+
+ # ax.relim does not support collections...
+ self._update_line_limits(container_new[0])
+ except RuntimeError as ex:
+ logger.information('Error bar not plotted: {0}'.format(ex.args[0]))
+ container_new = []
+ # also remove the curve from the legend
+ if (not self.is_empty(self)) and self.legend_ is not None:
+ legend_set_draggable(self.legend(), True)
+
+ return container_new
+
+ workspace = args[0]
+ spec_num = self.get_spec_number_or_bin(workspace, kwargs)
+ normalize_by_bin_width, kwargs = get_normalize_by_bin_width(workspace, self, **kwargs)
+ is_normalized = normalize_by_bin_width or workspace.isDistribution()
+
+ with autoscale_on_update(self, autoscale_on):
+ artist = self.track_workspace_artist(workspace,
+ axesfunctions.errorbar(self, normalize_by_bin_width = is_normalized,
+ *args, **kwargs),
+ _data_update, spec_num, is_normalized,
+ MantidAxes.is_axis_of_type(MantidAxType.SPECTRUM, kwargs))
+ return artist
+ else:
+ return Axes.errorbar(self, *args, **kwargs)
+
+ @plot_decorator
+ def pcolor(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.pcolor` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.pcolor(workspace) #for workspaces
+ ax.pcolor(x,y,C) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.pcolor`
+ """
+ return self._plot_2d_func('pcolor', *args, **kwargs)
+
+ @plot_decorator
+ def pcolorfast(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.pcolorfast` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matpolotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.pcolorfast(workspace) #for workspaces
+ ax.pcolorfast(x,y,C) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.pcolorfast`
+ """
+ return self._plot_2d_func('pcolorfast', *args, **kwargs)
+
+ @plot_decorator
+ def pcolormesh(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.pcolormesh` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.pcolormesh(workspace) #for workspaces
+ ax.pcolormesh(x,y,C) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.pcolormesh`
+ """
+ return self._plot_2d_func('pcolormesh', *args, **kwargs)
+
+ @plot_decorator
+ def imshow(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.imshow` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.imshow(workspace) #for workspaces
+ ax.imshow(C) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.imshow`
+ """
+ return self._plot_2d_func('imshow', *args, **kwargs)
+
+ def _plot_2d_func(self, name, *args, **kwargs):
+ """
+ Implementation of pcolor-style methods
+ :param name: The name of the method
+ :param args: The args passed from the user
+ :param kwargs: The kwargs passed from the use
+ :return: The return value of the pcolor* function
+ """
+ plotfunctions_func = getattr(axesfunctions, name)
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions')
+
+ def _update_data(artists, workspace, new_kwargs=None):
+ if new_kwargs:
+ return self._redraw_colorplot(plotfunctions_func, artists, workspace,
+ **new_kwargs)
+ return self._redraw_colorplot(plotfunctions_func, artists, workspace, **kwargs)
+
+ workspace = args[0]
+ normalize_by_bin_width, _ = get_normalize_by_bin_width(workspace, self, **kwargs)
+ is_normalized = normalize_by_bin_width or \
+ (hasattr(workspace, 'isDistribution') and workspace.isDistribution())
+ # We return the last mesh so the return type is a single artist like the standard Axes
+ artists = self.track_workspace_artist(workspace,
+ plotfunctions_func(self, *args, **kwargs),
+ _update_data, is_normalized=is_normalized)
+ try:
+ return artists[-1]
+ except TypeError:
+ return artists
+ else:
+ return getattr(Axes, name)(self, *args, **kwargs)
+
+ def _redraw_colorplot(self, colorfunc, artists_orig, workspace, **kwargs):
+ """
+ Redraw a pcolor*, imshow or contour type plot based on a new workspace
+ :param colorfunc: The Axes function to use to draw the new artist
+ :param artists_orig: A reference to an iterable of existing artists
+ :param workspace: A reference to the workspace object
+ :param kwargs: Any kwargs passed to the original call
+ """
+ for artist_orig in artists_orig:
+ if hasattr(artist_orig, 'remove'):
+ artist_orig.remove()
+ else: # for contour plots remove the collections
+ for col in artist_orig.collections:
+ col.remove()
+ if hasattr(artist_orig, 'colorbar_cid'):
+ artist_orig.callbacksSM.disconnect(artist_orig.colorbar_cid)
+ if artist_orig.norm.vmin == 0: # avoid errors with log 0
+ artist_orig.norm.vmin += 1e-6
+ artists_new = colorfunc(self, workspace, norm=artist_orig.norm, **kwargs)
+
+ artists_new.set_cmap(artist_orig.cmap)
+ if hasattr(artist_orig, 'interpolation'):
+ artists_new.set_interpolation(artist_orig.get_interpolation())
+
+ artists_new.autoscale()
+ artists_new.set_norm(
+ type(artist_orig.norm)(vmin=artists_new.norm.vmin, vmax=artists_new.norm.vmax))
+
+ if not isinstance(artists_new, Iterable):
+ artists_new = [artists_new]
+
+ try:
+ axesfunctions.update_colorplot_datalimits(self, artists_new)
+ except ValueError:
+ pass
+ # the type of plot can mutate back to single image from a multi collection
+ if len(artists_orig) == len(artists_new):
+ for artist_orig, artist_new in zip(artists_orig, artists_new):
+ if artist_orig.colorbar is not None:
+ self._attach_colorbar(artist_new, artist_orig.colorbar)
+ else:
+ # pick up the colorbar from the first one we find
+ for artist_orig in artists_orig:
+ if artist_orig.colorbar is not None:
+ self._attach_colorbar(artists_new[-1], artist_orig.colorbar)
+ break
+ self.set_aspect('auto')
+ return artists_new
+
+ @plot_decorator
+ def contour(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.contour` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.contour(workspace) #for workspaces
+ ax.contour(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.contour`
+ """
+ return self._plot_2d_func('contour', *args, **kwargs)
+
+ @plot_decorator
+ def contourf(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.contourf` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.contourf(workspace) #for workspaces
+ ax.contourf(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.contourf`
+ """
+ return self._plot_2d_func('contourf', *args, **kwargs)
+
+ @plot_decorator
+ def tripcolor(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.tripcolor` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.tripcolor(workspace) #for workspaces
+ ax.tripcolor(x,y,C) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.tripcolor`
+ """
+ return self._plot_2d_func('tripcolor', *args, **kwargs)
+
+ @plot_decorator
+ def tricontour(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.tricontour` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.tricontour(workspace) #for workspaces
+ ax.tricontour(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.tricontour`
+ """
+ return self._plot_2d_func('tricontour', *args, **kwargs)
+
+ @plot_decorator
+ def tricontourf(self, *args, **kwargs):
+ """
+ If the **mantid** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes.tricontourf` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
+ ax.tricontourf(workspace) #for workspaces
+ ax.tricontourf(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions.tricontourf`
+ """
+ return self._plot_2d_func('tricontourf', *args, **kwargs)
+
+ def is_waterfall(self):
+ return self.waterfall_x_offset != 0 or self.waterfall_y_offset != 0
+
+ def update_waterfall(self, x_offset, y_offset):
+ """
+ Changes the offset of a waterfall plot.
+ :param x_offset: The amount by which each line is shifted in the x axis.
+ :param y_offset: The amount by which each line is shifted in the y axis.
+ """
+ x_offset = int(x_offset)
+ y_offset = int(y_offset)
+
+ errorbar_cap_lines = datafunctions.remove_and_return_errorbar_cap_lines(self)
+
+ for i in range(len(self.get_lines())):
+ datafunctions.convert_single_line_to_waterfall(self, i, x_offset, y_offset)
+
+ if x_offset == 0 and y_offset == 0:
+ self.set_waterfall_fill(False)
+ logger.information("x and y offset have been set to zero so the plot is no longer a waterfall plot.")
+
+ if self.waterfall_has_fill():
+ datafunctions.waterfall_update_fill(self)
+
+ self.waterfall_x_offset = x_offset
+ self.waterfall_y_offset = y_offset
+
+ self.lines += errorbar_cap_lines
+
+ datafunctions.set_waterfall_toolbar_options_enabled(self)
+ self.get_figure().canvas.draw()
+
+ def set_waterfall(self, state, x_offset=None, y_offset=None, fill=False):
+ """
+ Convert between a normal 1D plot and a waterfall plot.
+ :param state: If true convert the plot to a waterfall plot, otherwise convert to a 1D plot.
+ :param x_offset: The amount by which each line is shifted in the x axis. Optional, default is 10.
+ :param y_offset: The amount by which each line is shifted in the y axis. Optional, default is 20.
+ :param fill: If true the area under each line is filled.
+ :raises: RuntimeError if state is true but there are less than two lines on the plot, if state is true but
+ x_offset and y_offset are 0, or if state is false but x_offset or y_offset is non-zero or fill is True.
+ """
+ if state:
+ if len(self.get_lines()) < 2:
+ raise RuntimeError("Axis must have multiple lines to be converted to a waterfall plot.")
+
+ if x_offset is None:
+ x_offset = WATERFALL_XOFFSET_DEFAULT
+
+ if y_offset is None:
+ y_offset = WATERFALL_YOFFSET_DEFAULT
+
+ if x_offset == 0 and y_offset == 0:
+ raise RuntimeError("You have set waterfall to true but have set the x and y offsets to zero.")
+
+ if self.is_waterfall():
+ # If the plot is already a waterfall plot but the provided x or y offset value is different to the
+ # current value, the new values are applied but a message is written to the logger to tell the user
+ # that they can use the update_waterfall function to do this.
+ if x_offset != self.waterfall_x_offset or y_offset != self.waterfall_y_offset:
+ logger.information("If your plot is already a waterfall plot you can use update_waterfall(x, y) to"
+ " change its offset values.")
+ else:
+ # Nothing needs to be changed.
+ logger.information("Plot is already a waterfall plot.")
+ return
+
+ # Set the width and height attributes if they haven't been already.
+ if not hasattr(self, 'width'):
+ datafunctions.set_initial_dimensions(self)
+ else:
+ if bool(x_offset) or bool(y_offset) or fill:
+ raise RuntimeError("You have set waterfall to false but have given a non-zero value for the offset or "
+ "set fill to true.")
+
+ if not self.is_waterfall():
+ # Nothing needs to be changed.
+ logger.information("Plot is already not a waterfall plot.")
+ return
+
+ x_offset = y_offset = 0
+
+ self.update_waterfall(x_offset, y_offset)
+
+ if fill:
+ self.set_waterfall_fill(True)
+
+ def waterfall_has_fill(self):
+ return any(isinstance(collection, PolyCollection) for collection in self.collections)
+
+ def set_waterfall_fill(self, enable, colour=None):
+ """
+ Toggle whether the area under each line on a waterfall plot is filled.
+ :param enable: If true, the filled areas are created, otherwise they are removed.
+ :param colour: Optional string for the colour of the filled areas. If None, the colour of each line is used.
+ :raises: RuntimeError if enable is false but colour is not None.
+ """
+ if not self.is_waterfall():
+ raise RuntimeError("Cannot toggle fill on non-waterfall plot.")
+
+ if enable:
+ datafunctions.waterfall_create_fill(self)
+
+ if colour:
+ datafunctions.solid_colour_fill(self, colour)
+ else:
+ datafunctions.line_colour_fill(self)
+ else:
+ if bool(colour):
+ raise RuntimeError("You have set fill to false but have given a colour.")
+
+ datafunctions.waterfall_remove_fill(self)
+
+ # ------------------ Private api --------------------------------------------------------
+
+ def _attach_colorbar(self, mappable, colorbar):
+ """
+ Attach the given colorbar to the mappable and update the clim values
+ :param mappable: An instance of a mappable
+ :param colorbar: An instance of a colorbar
+ """
+ cb = colorbar
+ cb.mappable = mappable
+ mappable.colorbar = cb
+ mappable.colorbar_cid = mappable.callbacksSM.connect('changed', cb.on_mappable_changed)
+ cb.update_normal(mappable)
+
+ def _remove_matching_curve_from_creation_args(self, workspace_name, workspace_index, spec_num):
+ """
+ Finds a curve from the same workspace and index, then removes it from the creation args.
+
+ :param workspace_name: Name of the workspace from which the curve was plotted
+ :type workspace_name: str
+ :param workspace_index: Index in the workspace that contained the data
+ :type workspace_index: int
+ :param spec_num: Spectrum number that contained the data. Used if the workspace was plotted using specNum kwarg.
+ Workspace index has priority if both are provided.
+ :type spec_num: int
+ :raises ValueError: if the curve does not exist in the creation_args of the axis
+ :returns: None
+ """
+ for index, creation_arg in enumerate(self.creation_args): # type: int, dict
+ if workspace_name == creation_arg["workspaces"]:
+ if creation_arg.get("wkspIndex", -1) == workspace_index or creation_arg.get(
+ "specNum", -1) == spec_num:
+ del self.creation_args[index]
+ return
+ raise ValueError("Curve does not have existing creation args")
+
+# -----------------------------------------------------------------------------
+# MantidAxes3D
+# -----------------------------------------------------------------------------
+class MantidAxes3D(Axes3D):
+ """
+ This class defines the **mantid3d** projection for 3d plotting. One chooses
+ this projection using::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
+
+ or::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+ fig = plt.figure()
+ ax = fig.add_subplot(111,projection='mantid3d')
+
+ The mantid3d projection allows replacing the array objects with mantid workspaces.
+ """
+
+ name = 'mantid3d'
+
+ def plot(self, *args, **kwargs):
+ """
+ If the **mantid3d** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes3D.plot` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
+ ax.plot(workspace) #for workspaces
+ ax.plot(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions3D.plot3D`
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions3D')
+ return axesfunctions3D.plot(self, *args, **kwargs)
+ else:
+ return Axes3D.plot(self, *args, **kwargs)
+
+ def scatter(self, *args, **kwargs):
+ """
+ If the **mantid3d** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes3D.scatter` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
+ ax.scatter(workspace) #for workspaces
+ ax.scatter(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions3D.scatter`
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions3D')
+ return axesfunctions3D.scatter(self, *args, **kwargs)
+ else:
+ return Axes3D.scatter(self, *args, **kwargs)
+
+ def plot_wireframe(self, *args, **kwargs):
+ """
+ If the **mantid3d** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes3D.plot_wireframe` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
+ ax.plot_wireframe(workspace) #for workspaces
+ ax.plot_wireframe(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions3D.wireframe`
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions3D')
+ return axesfunctions3D.plot_wireframe(self, *args, **kwargs)
+ else:
+ return Axes3D.plot_wireframe(self, *args, **kwargs)
+
+ def plot_surface(self, *args, **kwargs):
+ """
+ If the **mantid3d** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes3D.plot_surface` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
+ ax.plot_surface(workspace) #for workspaces
+ ax.plot_surface(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions3D.plot_surface`
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions3D')
+ return axesfunctions3D.plot_surface(self, *args, **kwargs)
+ else:
+ return Axes3D.plot_surface(self, *args, **kwargs)
+
+ def contour(self, *args, **kwargs):
+ """
+ If the **mantid3d** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes3D.contour` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
+ ax.contour(workspace) #for workspaces
+ ax.contour(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions3D.contour`
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions3D')
+ return axesfunctions3D.contour(self, *args, **kwargs)
+ else:
+ return Axes3D.contour(self, *args, **kwargs)
+
+ def contourf(self, *args, **kwargs):
+ """
+ If the **mantid3d** projection is chosen, it can be
+ used the same as :py:meth:`matplotlib.axes.Axes3D.contourf` for arrays,
+ or it can be used to plot :class:`mantid.api.MatrixWorkspace`
+ or :class:`mantid.api.IMDHistoWorkspace`. You can have something like::
+
+ import matplotlib.pyplot as plt
+ from mantid import plots
+
+ ...
+
+ fig, ax = plt.subplots(subplot_kw={'projection':'mantid3d'})
+ ax.contourf(workspace) #for workspaces
+ ax.contourf(x,y,z) #for arrays
+ fig.show()
+
+ For keywords related to workspaces, see :func:`plotfunctions3D.contourf`
+ """
+ if datafunctions.validate_args(*args):
+ logger.debug('using plotfunctions3D')
+ return axesfunctions3D.contourf(self, *args, **kwargs)
+ else:
+ return Axes3D.contourf(self, *args, **kwargs)
+
+
+class _WorkspaceArtists(object):
+ """Captures information regarding an artist that has been plotted
+ from a workspace. It allows for removal and replacement of said artists
+
+ """
+ def __init__(self,
+ artists,
+ data_replace_cb,
+ is_normalized,
+ workspace_name=None,
+ spec_num=None,
+ is_spec=True):
+ """
+ Initialize an instance
+ :param artists: A reference to a list of artists "attached" to a workspace
+ :param data_replace_cb: A reference to a callable with signature (artists, workspace) -> new_artists
+ :param is_normalized: bool specifying whether the line being plotted is a distribution
+ :param workspace_name: String. The name of the associated workspace
+ :param spec_num: The spectrum number of the spectrum used to plot the artist
+ :param is_spec: True if spec_num represents a spectrum rather than a bin
+ """
+ self._set_artists(artists)
+ self._data_replace_cb = data_replace_cb
+ self.workspace_name = workspace_name
+ self.spec_num = spec_num
+ self.is_spec = is_spec
+ self.workspace_index = self._get_workspace_index()
+ self.is_normalized = is_normalized
+
+ def _get_workspace_index(self):
+ """Get the workspace index (spectrum or bin index) of the workspace artist"""
+ if self.spec_num is None or self.workspace_name is None:
+ return None
+ try:
+ if self.is_spec:
+ return ads.retrieve(self.workspace_name).getIndexFromSpectrumNumber(self.spec_num)
+ else:
+ return self.spec_num
+ except KeyError: # Return None if the workspace is not in the ADS
+ return None
+
+ def remove(self, axes):
+ """
+ Remove the tracked artists from the given axes
+ :param axes: A reference to the axes instance the artists are attached to
+ """
+ # delete the artists from the axes
+ self._remove(axes, self._artists)
+
+ def remove_if(self, axes, predicate):
+ """
+ Remove the tracked artists from the given axes if they return true from predicate
+ :param axes: A reference to the axes instance the artists are attached to
+ :param predicate: A function which takes a matplotlib artist object and returns a boolean
+ :returns: Returns a bool specifying whether the class is now empty
+ """
+ artists_to_remove = []
+ artists_to_keep = []
+ for artist in self._artists:
+ if predicate(artist):
+ artists_to_remove.append(artist)
+ else:
+ artists_to_keep.append(artist)
+
+ self._remove(axes, artists_to_remove)
+ self._artists = artists_to_keep
+
+ return len(self._artists) == 0
+
+ def _remove(self, axes, artists):
+ # delete the artists from the axes
+ for artist in artists:
+ artist.remove()
+ # Remove doesn't catch removing the container for errorbars etc
+ if isinstance(artist, Container):
+ try:
+ axes.containers.remove(artist)
+ except ValueError:
+ pass
+
+ if (not axes.is_empty(axes)) and axes.legend_ is not None:
+ axes.make_legend()
+
+ def replace_data(self, workspace, plot_kwargs=None):
+ """Replace or replot artists based on a new workspace
+ :param workspace: The new workspace containing the data
+ :param plot_kwargs: Key word args to pass to plotting function
+ """
+ if plot_kwargs:
+ new_artists = self._data_replace_cb(self._artists, workspace, plot_kwargs)
+ else:
+ new_artists = self._data_replace_cb(self._artists, workspace)
+ self._set_artists(new_artists)
+ return len(self._artists) == 0
+
+ def _set_artists(self, artists):
+ """Ensure the stored artists is an iterable"""
+ if isinstance(artists, Container) or not isinstance(artists, Iterable):
+ self._artists = [artists]
+ else:
+ self._artists = artists
\ No newline at end of file
diff --git a/Framework/PythonInterface/mantid/plots/plotfunctions.py b/Framework/PythonInterface/mantid/plots/plotfunctions.py
index a926ebac60386083831049b3b4add6189a5ddcd0..533fb25c1cc904bf6182dd94c9f6346efd7eefdc 100644
--- a/Framework/PythonInterface/mantid/plots/plotfunctions.py
+++ b/Framework/PythonInterface/mantid/plots/plotfunctions.py
@@ -5,760 +5,360 @@
# & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
# This file is part of the mantid package
-#
-#
-from __future__ import (absolute_import, division, print_function)
+from __future__ import absolute_import
+# std imports
+import math
+import numpy as np
import collections
-import matplotlib
-import matplotlib.collections as mcoll
-import matplotlib.colors
-import matplotlib.dates as mdates
-import matplotlib.image as mimage
-import numpy
-import sys
-
-import mantid.api
-import mantid.kernel
-import mantid.plots.modest_image
-from mantid.plots.helperfunctions import get_axes_labels, get_bins, get_data_uneven_flag, get_distribution, \
- get_matrix_2d_ragged, get_matrix_2d_data, get_md_data1d, get_md_data2d_bin_bounds, \
- get_md_data2d_bin_centers, get_normalization, get_sample_log, get_spectrum, get_uneven_data, \
- get_wksp_index_dist_and_label, check_resample_to_regular_grid, get_indices, get_normalize_by_bin_width
-from mantid.plots.utility import MantidAxType
-
-# Used for initializing searches of max, min values
-_LARGEST, _SMALLEST = float(sys.maxsize), -sys.maxsize
-
-
-# ================================================
-# Private 2D Helper functions
-# ================================================
-
-def _setLabels1D(axes, workspace, indices=None, normalize_by_bin_width=True,
- axis=MantidAxType.SPECTRUM):
- '''
- helper function to automatically set axes labels for 1D plots
- '''
- labels = get_axes_labels(workspace, indices, normalize_by_bin_width)
- # We assume that previous checking has ensured axis can only be 1 of 2 types
- axes.set_xlabel(labels[1 if axis == MantidAxType.SPECTRUM else 2])
- axes.set_ylabel(labels[0])
-
-
-def _setLabels2D(axes, workspace, indices=None, transpose=False,
- xscale=None, normalize_by_bin_width=True):
- '''
- helper function to automatically set axes labels for 2D plots
- '''
- labels = get_axes_labels(workspace, indices, normalize_by_bin_width)
- if transpose:
- axes.set_xlabel(labels[2])
- axes.set_ylabel(labels[1])
- else:
- axes.set_xlabel(labels[1])
- axes.set_ylabel(labels[2])
- axes.set_title(labels[0])
- if xscale is None and hasattr(workspace, 'isCommonLogBins') and workspace.isCommonLogBins():
- axes.set_xscale('log')
- elif xscale is not None:
- axes.set_xscale(xscale)
-
-
-def _get_data_for_plot(axes, workspace, kwargs, with_dy=False, with_dx=False):
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- (x, y, dy) = get_md_data1d(workspace, normalization, indices)
- dx = None
- axis = None
- else:
- axis = MantidAxType(kwargs.pop("axis", MantidAxType.SPECTRUM))
- normalize_by_bin_width, kwargs = get_normalize_by_bin_width(
- workspace, axes, **kwargs)
- workspace_index, distribution, kwargs = get_wksp_index_dist_and_label(workspace, axis, **kwargs)
- if axis == MantidAxType.BIN:
- # Overwrite any user specified xlabel
- axes.set_xlabel("Spectrum")
- x, y, dy, dx = get_bins(workspace, workspace_index, with_dy)
- elif axis == MantidAxType.SPECTRUM:
- x, y, dy, dx = get_spectrum(workspace, workspace_index,
- normalize_by_bin_width, with_dy, with_dx)
- else:
- raise ValueError("Axis {} is not a valid axis number.".format(axis))
- indices = None
- return x, y, dy, dx, indices, axis, kwargs
-
-
-# ========================================================
-# Plot functions
-# ========================================================
-def _plot_impl(axes, workspace, args, kwargs):
+# 3rd party imports
+from matplotlib.gridspec import GridSpec
+from matplotlib.legend import Legend
+
+# local imports
+from mantid.api import AnalysisDataService, MatrixWorkspace
+from mantid.kernel import ConfigService
+from mantid.plots import datafunctions, MantidAxes
+from mantid.py3compat import is_text_string, string_types
+
+# -----------------------------------------------------------------------------
+# Constants
+# -----------------------------------------------------------------------------
+PROJECTION = 'mantid'
+
+MARKER_MAP = {'square': 's', 'plus (filled)': 'P', 'point': '.', 'tickdown': 3,
+ 'triangle_right': '>', 'tickup': 2, 'hline': '_', 'vline': '|',
+ 'pentagon': 'p', 'tri_left': '3', 'caretdown': 7,
+ 'caretright (centered at base)': 9, 'tickright': 1,
+ 'caretright': 5, 'caretleft': 4, 'tickleft': 0, 'tri_up': '2',
+ 'circle': 'o', 'pixel': ',', 'caretleft (centered at base)': 8,
+ 'diamond': 'D', 'star': '*', 'hexagon1': 'h', 'octagon': '8',
+ 'hexagon2': 'H', 'tri_right': '4', 'x (filled)': 'X',
+ 'thin_diamond': 'd', 'tri_down': '1', 'triangle_left': '<',
+ 'plus': '+', 'triangle_down': 'v', 'triangle_up': '^', 'x': 'x',
+ 'caretup': 6, 'caretup (centered at base)': 10,
+ 'caretdown (centered at base)': 11, 'None': 'None'}
+
+# -----------------------------------------------------------------------------
+# Decorators
+# -----------------------------------------------------------------------------
+def manage_workspace_names(func):
"""
- Compute data and labels for plot. Used by workspace
- replacement handlers to recompute data. See plot for
- argument details
+ A decorator to go around plotting functions.
+ This will retrieve workspaces from workspace names before
+ calling the plotting function
+ :param func: A plotting function
+ :return:
"""
- if 'LogName' in kwargs:
- (x, y, FullTime, LogName, units, kwargs) = get_sample_log(workspace, **kwargs)
- axes.set_ylabel('{0} ({1})'.format(LogName, units))
- axes.set_xlabel('Time (s)')
- if FullTime:
- axes.xaxis_date()
- axes.xaxis.set_major_formatter(mdates.DateFormatter('%H:%M:%S\n%b-%d'))
- axes.set_xlabel('Time')
- kwargs['linestyle'] = 'steps-post'
- else:
- normalize_by_bin_width, kwargs = get_normalize_by_bin_width(
- workspace, axes, **kwargs)
- x, y, _, _, indices, axis, kwargs = _get_data_for_plot(axes, workspace, kwargs)
- if kwargs.pop('update_axes_labels', True):
- _setLabels1D(axes, workspace, indices,
- normalize_by_bin_width=normalize_by_bin_width, axis=axis)
- kwargs.pop('normalize_by_bin_width', None)
- return x, y, args, kwargs
+ def inner_func(workspaces, *args, **kwargs):
+ workspaces = _validate_workspace_names(workspaces)
+ return func(workspaces, *args, **kwargs)
-def plot(axes, workspace, *args, **kwargs):
- """
- Unpack mantid workspace and render it with matplotlib. ``args`` and
- ``kwargs`` are passed to :py:meth:`matplotlib.axes.Axes.plot` after special
- keyword arguments are removed. This will automatically label the
- line according to the spectrum number unless specified otherwise.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param specNum: spectrum number to plot if MatrixWorkspace
- :param wkspIndex: workspace index to plot if MatrixWorkspace
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the workspace is a MatrixWorkspace histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param normalize_by_bin_width: ``None`` (default) ask the workspace. It can override
- the value from distribution. Is implemented so get_normalize_by_bin_width
- only need to be run once.
- :param LogName: if specified, it will plot the corresponding sample log. The x-axis
- of the plot is the time difference between the log time and the first
- value of the `proton_charge` log (if available) or the sample log's
- first time.
- :param StartFromLog: False by default. If True the time difference will be from the sample log's
- first time, even if `proton_charge` log is available.
- :param FullTime: False by default. If true, the full date and time will be plotted on the axis
- instead of the time difference
- :param ExperimentInfo: for MD Workspaces with multiple :class:`mantid.api.ExperimentInfo` is the
- ExperimentInfo object from which to extract the log. It's 0 by default
- :param axis: Specify which axis will be plotted. Use axis=MantidAxType.BIN to plot a bin,
- and axis=MantidAxType.SPECTRUM to plot a spectrum.
- The default value is axis=1, plotting spectra by default.
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimension to plot. *e.g.* to select the second axis to plot from a
- 3D volume use ``indices=(5, slice(None), 10)`` where the 5/10 are the bins selected
- for the other 2 axes.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the second
- axis to plot from a 3D volume use ``slicepoint=(1.0, None, 2.0)`` where the 1.0/2.0 are
- the dimension selected for the other 2 axes.
-
- For matrix workspaces with more than one spectra, either ``specNum`` or ``wkspIndex``
- needs to be specified. Giving both will generate a :class:`RuntimeError`. There is no similar
- keyword for MDHistoWorkspaces. These type of workspaces have to have exactly one non integrated
- dimension
+ return inner_func
+
+
+# -----------------------------------------------------------------------------
+# Public Methods
+# -----------------------------------------------------------------------------
+def figure_title(workspaces, fig_num):
+ """Create a default figure title from a single workspace, list of workspaces or
+ workspace names and a figure number. The name of the first workspace in the list
+ is concatenated with the figure number.
+
+ :param workspaces: A single workspace, list of workspaces or workspace name/list of workspace names
+ :param fig_num: An integer denoting the figure number
+ :return: A title for the figure
"""
- x, y, args, kwargs = _plot_impl(axes, workspace, args, kwargs)
- return axes.plot(x, y, *args, **kwargs)
+ def wsname(w):
+ return w.name() if hasattr(w, 'name') else w
+
+ if is_text_string(workspaces) or not isinstance(workspaces, collections.Sequence):
+ # assume a single workspace
+ first = workspaces
+ else:
+ assert len(workspaces) > 0
+ first = workspaces[0]
+
+ return wsname(first) + '-' + str(fig_num)
-def errorbar(axes, workspace, *args, **kwargs):
+@manage_workspace_names
+def plot(workspaces, spectrum_nums=None, wksp_indices=None, errors=False,
+ overplot=False, fig=None, plot_kwargs=None, ax_properties=None,
+ window_title=None, tiled=False, waterfall=False):
"""
- Unpack mantid workspace and render it with matplotlib. ``args`` and
- ``kwargs`` are passed to :py:meth:`matplotlib.axes.Axes.errorbar` after special
- keyword arguments are removed. This will automatically label the
- line according to the spectrum number unless specified otherwise.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param specNum: spectrum number to plot if MatrixWorkspace
- :param wkspIndex: workspace index to plot if MatrixWorkspace
- :param distribution: ``None`` (default) asks the global setting. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the workspace is a MatrixWorkspace histogram.
- :param normalize_by_bin_width: Plot the workspace as a distribution. If None default to global
- setting: config['graph1d.autodistribution']
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param axis: Specify which axis will be plotted. Use axis=MantidAxType.BIN to plot a bin,
- and axis=MantidAxType.SPECTRUM to plot a spectrum.
- The default value is axis=1, plotting spectra by default.
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimension to plot. *e.g.* to select the second axis to plot from a
- 3D volume use ``indices=(5, slice(None), 10)`` where the 5/10 are the bins selected
- for the other 2 axes.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the second
- axis to plot from a 3D volume use ``slicepoint=(1.0, None, 2.0)`` where the 1.0/2.0 are
- the dimension selected for the other 2 axes.
-
- For matrix workspaces with more than one spectra, either ``specNum`` or ``wkspIndex``
- needs to be specified. Giving both will generate a :class:`RuntimeError`. There is no similar
- keyword for MDHistoWorkspaces. These type of workspaces have to have exactly one non integrated
- dimension
+ Create a figure with a single subplot and for each workspace/index add a
+ line plot to the new axes. show() is called before returning the figure instance. A legend
+ is added.
+
+ :param workspaces: A list of workspace handles or strings
+ :param spectrum_nums: A list of spectrum number identifiers (general start from 1)
+ :param wksp_indices: A list of workspace indexes (starts from 0)
+ :param errors: If true then error bars are added for each plot
+ :param overplot: If true then overplot over the current figure if one exists. If an axis object the overplotting
+ will be done on the axis passed in
+ :param fig: If not None then use this Figure object to plot
+ :param plot_kwargs: Arguments that will be passed onto the plot function
+ :param ax_properties: A dict of axes properties. E.g. {'yscale': 'log'}
+ :param window_title: A string denoting name of the GUI window which holds the graph
+ :param tiled: An optional flag controlling whether to do a tiled or overlayed plot
+ :param waterfall: An optional flag controlling whether or not to do a waterfall plot
+ :return: The figure containing the plots
"""
- normalize_by_bin_width, kwargs = get_normalize_by_bin_width(
- workspace, axes, **kwargs)
- x, y, dy, dx, indices, axis, kwargs = _get_data_for_plot(
- axes, workspace, kwargs, with_dy=True, with_dx=False)
- if kwargs.pop('update_axes_labels', True):
- _setLabels1D(axes, workspace, indices,
- normalize_by_bin_width=normalize_by_bin_width, axis=axis)
-
- return axes.errorbar(x, y, dy, dx, *args, **kwargs)
-
-
-def scatter(axes, workspace, *args, **kwargs):
- '''
- Unpack mantid workspace and render it with matplotlib. ``args`` and
- ``kwargs`` are passed to :py:meth:`matplotlib.axes.Axes.scatter` after special
- keyword arguments are removed. This will automatically label the
- line according to the spectrum number unless specified otherwise.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param specNum: spectrum number to plot if MatrixWorkspace
- :param wkspIndex: workspace index to plot if MatrixWorkspace
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the workspace is a MatrixWorkspace histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimension to plot. *e.g.* to select the second axis to plot from a
- 3D volume use ``indices=(5, slice(None), 10)`` where the 5/10 are the bins selected
- for the other 2 axes.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the second
- axis to plot from a 3D volume use ``slicepoint=(1.0, None, 2.0)`` where the 1.0/2.0 are
- the dimension selected for the other 2 axes.
-
- For matrix workspaces with more than one spectra, either ``specNum`` or ``wkspIndex``
- needs to be specified. Giving both will generate a :class:`RuntimeError`. There is no similar
- keyword for MDHistoWorkspaces. These type of workspaces have to have exactly one non integrated
- dimension
- '''
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- (x, y, _) = get_md_data1d(workspace, normalization, indices)
- _setLabels1D(axes, workspace, indices)
- else:
- (wkspIndex, distribution, kwargs) = get_wksp_index_dist_and_label(workspace, **kwargs)
- (x, y, _, _) = get_spectrum(workspace, wkspIndex, distribution)
- _setLabels1D(axes, workspace)
- return axes.scatter(x, y, *args, **kwargs)
-
-
-def contour(axes, workspace, *args, **kwargs):
- '''
- Essentially the same as :meth:`matplotlib.axes.Axes.contour`
- but calculates the countour levels. Currently this only works with
- workspaces that have a constant number of bins between spectra.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x, y, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
- _setLabels2D(axes, workspace, indices, transpose)
- else:
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose)
- return axes.contour(x, y, z, *args, **kwargs)
-
-
-def contourf(axes, workspace, *args, **kwargs):
- '''
- Essentially the same as :meth:`matplotlib.axes.Axes.contourf`
- but calculates the countour levels. Currently this only works with
- workspaces that have a constant number of bins between spectra.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x, y, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
- _setLabels2D(axes, workspace, indices, transpose)
- else:
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose)
- return axes.contourf(x, y, z, *args, **kwargs)
-
-
-def _pcolorpieces(axes, workspace, distribution, *args, **kwargs):
- '''
- Helper function for pcolor, pcolorfast, and pcolormesh that will
- plot a 2d representation of each spectra. The polycollections or meshes
- will be normalized to the same intensity limits.
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param pcolortype: this keyword allows the plotting to be one of pcolormesh or
- pcolorfast if there is "mesh" or "fast" in the value of the keyword, or
- pcolor by default
- :return: A list of the pcolor pieces created
- '''
- (x, y, z) = get_uneven_data(workspace, distribution)
- mini = numpy.min([numpy.min(i) for i in z])
- maxi = numpy.max([numpy.max(i) for i in z])
- if 'vmin' in kwargs:
- mini = kwargs['vmin']
- if 'vmax' in kwargs:
- maxi = kwargs['vmax']
- if 'norm' not in kwargs:
- kwargs['norm'] = matplotlib.colors.Normalize(vmin=mini, vmax=maxi)
- else:
- if kwargs['norm'].vmin is None:
- kwargs['norm'].vmin = mini
- if kwargs['norm'].vmax is None:
- kwargs['norm'].vmax = maxi
-
- # setup the particular pcolor to use
- pcolortype = kwargs.pop('pcolortype', '').lower()
- if 'mesh' in pcolortype:
- pcolor = axes.pcolormesh
- elif 'fast' in pcolortype:
- pcolor = axes.pcolorfast
+ if plot_kwargs is None:
+ plot_kwargs = {}
+ _validate_plot_inputs(workspaces, spectrum_nums, wksp_indices, tiled, overplot)
+ workspaces = [ws for ws in workspaces if isinstance(ws, MatrixWorkspace)]
+
+ if spectrum_nums is not None:
+ kw, nums = 'specNum', spectrum_nums
else:
- pcolor = axes.pcolor
-
- pieces = []
- for xi, yi, zi in zip(x, y, z):
- XX, YY = numpy.meshgrid(xi, yi, indexing='ij')
- pieces.append(pcolor(XX, YY, zi.reshape(-1, 1), **kwargs))
-
- return pieces
-
-
-def pcolor(axes, workspace, *args, **kwargs):
- '''
- Essentially the same as :meth:`matplotlib.axes.Axes.pcolor`
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param axisaligned: ``False`` (default). If ``True``, or if the workspace has a variable
- number of bins, the polygons will be aligned with the axes
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x, y, z = get_md_data2d_bin_bounds(workspace, normalization, indices, transpose)
- _setLabels2D(axes, workspace, indices, transpose)
+ kw, nums = 'wkspIndex', wksp_indices
+
+ _add_default_plot_kwargs_from_settings(plot_kwargs, errors)
+
+ num_axes = len(workspaces) * len(nums) if tiled else 1
+
+ fig, axes = get_plot_fig(overplot, ax_properties, window_title, num_axes, fig)
+
+ # Convert to a MantidAxes if it isn't already. Ignore legend since
+ # a new one will be drawn later
+ axes = [MantidAxes.from_mpl_axes(ax, ignore_artists=[Legend]) if not isinstance(ax, MantidAxes) else ax
+ for ax in axes]
+
+ if tiled:
+ ws_index = [(ws, index) for ws in workspaces for index in nums]
+ for index, ax in enumerate(axes):
+ if index < len(ws_index):
+ _do_single_plot(ax, [ws_index[index][0]], errors, False, [ws_index[index][1]], kw, plot_kwargs)
+ else:
+ ax.axis('off')
else:
- (aligned, kwargs) = check_resample_to_regular_grid(workspace, **kwargs)
- (normalize_by_bin_width, kwargs) = get_normalize_by_bin_width(workspace, axes, **kwargs)
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- if aligned:
- kwargs['pcolortype'] = ''
- return _pcolorpieces(axes, workspace, distribution, *args, **kwargs)
- else:
- (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=True, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose, normalize_by_bin_width=normalize_by_bin_width)
- return axes.pcolor(x, y, z, *args, **kwargs)
-
-
-def pcolorfast(axes, workspace, *args, **kwargs):
- '''
- Essentially the same as :meth:`matplotlib.axes.Axes.pcolorfast`
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param axisaligned: ``False`` (default). If ``True``, or if the workspace has a variable
- number of bins, the polygons will be aligned with the axes
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x, y, z = get_md_data2d_bin_bounds(workspace, normalization, indices, transpose)
- _setLabels2D(axes, workspace, indices, transpose)
+ show_title = ("on" == ConfigService.getString("plots.ShowTitle").lower()) and not overplot
+ ax = overplot if isinstance(overplot, MantidAxes) else axes[0]
+ ax.axis('on')
+ _do_single_plot(ax, workspaces, errors, show_title, nums, kw, plot_kwargs)
+
+ # Can't have a waterfall plot with only one line.
+ if len(nums)*len(workspaces) == 1 and waterfall:
+ waterfall = False
+
+ # The plot's initial xlim and ylim are used to offset each curve in a waterfall plot.
+ # Need to do this whether the current curve is a waterfall plot or not because it may be converted later.
+ if not overplot:
+ datafunctions.set_initial_dimensions(ax)
+
+ if waterfall:
+ ax.set_waterfall(True)
+
+ if not overplot:
+ fig.canvas.set_window_title(figure_title(workspaces, fig.number))
else:
- (aligned, kwargs) = check_resample_to_regular_grid(workspace, **kwargs)
- (normalize_by_bin_width, kwargs) = get_normalize_by_bin_width(workspace, axes, **kwargs)
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- if aligned:
- kwargs['pcolortype'] = 'fast'
- return _pcolorpieces(axes, workspace, distribution, *args, **kwargs)
- else:
- (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=True, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose, normalize_by_bin_width=normalize_by_bin_width)
- return axes.pcolorfast(x, y, z, *args, **kwargs)
-
-
-def pcolormesh(axes, workspace, *args, **kwargs):
- '''
- Essentially the same as :meth:`matplotlib.axes.Axes.pcolormesh`.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param axisaligned: ``False`` (default). If ``True``, or if the workspace has a variable
- number of bins, the polygons will be aligned with the axes
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x, y, z = get_md_data2d_bin_bounds(workspace, normalization, indices, transpose)
- _setLabels2D(axes, workspace, indices, transpose)
+ if ax.is_waterfall():
+ for i in range(len(nums)*len(workspaces)):
+ errorbar_cap_lines = datafunctions.remove_and_return_errorbar_cap_lines(ax)
+ datafunctions.convert_single_line_to_waterfall(ax, len(ax.get_lines()) - (i + 1))
+
+ if ax.waterfall_has_fill():
+ datafunctions.waterfall_update_fill(ax)
+
+ ax.lines += errorbar_cap_lines
+
+ # This updates the toolbar so the home button now takes you back to this point.
+ # The try catch is in case the manager does not have a toolbar attached.
+ try:
+ fig.canvas.manager.toolbar.update()
+ except AttributeError:
+ pass
+
+ fig.canvas.draw()
+ # This displays the figure, but only works if a manager is attached to the figure.
+ # The try catch is in case a figure manager is not present
+ try:
+ fig.show()
+ except AttributeError:
+ pass
+
+ return fig
+
+
+def create_subplots(nplots, fig=None):
+ """
+ Create a set of subplots suitable for a given number of plots. A stripped down
+ version of plt.subplots that can accept an existing figure instance.
+
+ :param nplots: The number of plots required
+ :param fig: An optional figure. It is cleared before plotting the new contents
+ :return: A 2-tuple of (fig, axes)
+ """
+ import matplotlib.pyplot as plt
+ square_side_len = int(math.ceil(math.sqrt(nplots)))
+ nrows, ncols = square_side_len, square_side_len
+ if square_side_len * square_side_len != nplots:
+ # not a square number - square_side_len x square_side_len
+ # will be large enough but we could end up with an empty
+ # row so chop that off
+ if nplots <= (nrows - 1) * ncols:
+ nrows -= 1
+
+ if fig is None:
+ fig = plt.figure()
else:
- (aligned, kwargs) = check_resample_to_regular_grid(workspace, **kwargs)
- (normalize_by_bin_width, kwargs) = get_normalize_by_bin_width(workspace, axes, **kwargs)
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- if aligned:
- kwargs['pcolortype'] = 'mesh'
- return _pcolorpieces(axes, workspace, distribution, *args, **kwargs)
- else:
- (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=True, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose, normalize_by_bin_width=normalize_by_bin_width)
- return axes.pcolormesh(x, y, z, *args, **kwargs)
-
-
-def imshow(axes, workspace, *args, **kwargs):
- '''
- Essentially the same as :meth:`matplotlib.axes.Axes.imshow`.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param axisaligned: ``False`` (default). If ``True``, or if the workspace has a variable
- number of bins, the polygons will be aligned with the axes
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x, y, z = get_md_data2d_bin_bounds(workspace, normalization, indices, transpose)
- _setLabels2D(axes, workspace, indices, transpose)
+ fig.clf()
+ # annoyling this repl
+ nplots = nrows * ncols
+ gs = GridSpec(nrows, ncols)
+ axes = np.empty(nplots, dtype=object)
+ ax0 = fig.add_subplot(gs[0, 0], projection=PROJECTION)
+ axes[0] = ax0
+ for i in range(1, nplots):
+ axes[i] = fig.add_subplot(gs[i // ncols, i % ncols],
+ projection=PROJECTION)
+ axes = axes.reshape(nrows, ncols)
+
+ return fig, axes, nrows, ncols
+
+
+def raise_if_not_sequence(value, seq_name, element_type=None):
+ """
+ Raise a ValueError if the given object is not a sequence
+
+ :param value: The value object to validate
+ :param seq_name: The variable name of the sequence for the error message
+ :param element_type: An optional type to provide to check that each element
+ is an instance of this type
+ :raises ValueError: if the conditions are not met
+ """
+ accepted_types = (list, tuple, range)
+ if type(value) not in accepted_types:
+ raise ValueError("{} should be a list or tuple, "
+ "instead found '{}'".format(seq_name,
+ value.__class__.__name__))
+ if element_type is not None:
+ def raise_if_not_type(x):
+ if not isinstance(x, element_type):
+ if element_type == MatrixWorkspace:
+ # If the workspace is the wrong type, log the error and remove it from the list so that the other
+ # workspaces can still be plotted.
+ LOGGER.warning("{} has unexpected type '{}'".format(x, x.__class__.__name__))
+ else:
+ raise ValueError("Unexpected type: '{}'".format(x.__class__.__name__))
+
+ # Map in Python3 is an iterator, so ValueError will not be raised unless the values are yielded.
+ # converting to a list forces yielding
+ list(map(raise_if_not_type, value))
+
+
+def get_plot_fig(overplot=None, ax_properties=None, window_title=None, axes_num=1, fig=None):
+ """
+ Create a blank figure and axes, with configurable properties.
+ :param overplot: If true then plotting on figure will plot over previous plotting. If an axis object the overplotting
+ will be done on the axis passed in
+ :param ax_properties: A dict of axes properties. E.g. {'yscale': 'log'} for log y-axis
+ :param window_title: A string denoting the name of the GUI window which holds the graph
+ :param axes_num: The number of axes to create on the figure
+ :param fig: An optional figure object
+ :return: Matplotlib fig and axes objects
+ """
+ import matplotlib.pyplot as plt
+ if fig and overplot:
+ fig = fig
+ elif fig:
+ fig, _, _, _ = create_subplots(axes_num, fig)
+ elif overplot:
+ fig = plt.gcf()
else:
- (aligned, kwargs) = check_resample_to_regular_grid(workspace, **kwargs)
- (normalize_by_bin_width, kwargs) = get_normalize_by_bin_width(workspace, axes, **kwargs)
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- if aligned:
- (x, y, z) = get_matrix_2d_ragged(workspace, normalize_by_bin_width, histogram2D=True, transpose=transpose)
+ fig, _, _, _ = create_subplots(axes_num)
+
+ if not ax_properties:
+ ax_properties = {}
+ if ConfigService.getString("plots.xAxesScale").lower() == 'log':
+ ax_properties['xscale'] = 'log'
else:
- (x, y, z) = get_matrix_2d_data(workspace, distribution=distribution, histogram2D=True, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose, normalize_by_bin_width=normalize_by_bin_width)
- if 'extent' not in kwargs:
- if x.ndim == 2 and y.ndim == 2:
- kwargs['extent'] = [x[0, 0], x[0, -1], y[0, 0], y[-1, 0]]
+ ax_properties['xscale'] = 'linear'
+ if ConfigService.getString("plots.yAxesScale").lower() == 'log':
+ ax_properties['yscale'] = 'log'
else:
- kwargs['extent'] = [x[0], x[-1], y[0], y[-1]]
- return mantid.plots.modest_image.imshow(axes, z, *args, **kwargs)
-
-
-def tripcolor(axes, workspace, *args, **kwargs):
- '''
- To be used with non-uniform grids. Currently this only works with workspaces
- that have a constant number of bins between spectra or with
- MDHistoWorkspaces.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
-
- See :meth:`matplotlib.axes.Axes.tripcolor` for more information.
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x_temp, y_temp, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
- x, y = numpy.meshgrid(x_temp, y_temp)
- _setLabels2D(axes, workspace, indices, transpose)
- else:
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose)
- return axes.tripcolor(x.ravel(), y.ravel(), z.ravel(), *args, **kwargs)
-
-
-def tricontour(axes, workspace, *args, **kwargs):
- '''
- Essentially the same as :meth:`mantid.plots.contour`, but works
- for non-uniform grids. Currently this only works with workspaces
- that have a constant number of bins between spectra or with
- MDHistoWorkspaces.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
-
- See :meth:`matplotlib.axes.Axes.tricontour` for more information.
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x_temp, y_temp, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
- x, y = numpy.meshgrid(x_temp, y_temp)
- _setLabels2D(axes, workspace, indices, transpose)
- else:
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose)
- # tricontour segfaults if many z values are not finite
- # https://github.com/matplotlib/matplotlib/issues/10167
- x = x.ravel()
- y = y.ravel()
- z = z.ravel()
- condition = numpy.isfinite(z)
- x = x[condition]
- y = y[condition]
- z = z[condition]
- return axes.tricontour(x, y, z, *args, **kwargs)
-
-
-def tricontourf(axes, workspace, *args, **kwargs):
- '''
- Essentially the same as :meth:`mantid.plots.contourf`, but works
- for non-uniform grids. Currently this only works with workspaces
- that have a constant number of bins between spectra or with
- MDHistoWorkspaces.
-
- :param axes: :class:`matplotlib.axes.Axes` object that will do the plotting
- :param workspace: :class:`mantid.api.MatrixWorkspace` or :class:`mantid.api.IMDHistoWorkspace`
- to extract the data from
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the matrix workspace is a histogram.
- :param normalization: ``None`` (default) ask the workspace. Applies to MDHisto workspaces. It can override
- the value from displayNormalizationHisto. It checks only if
- the normalization is mantid.api.MDNormalization.NumEventsNormalization
- :param indices: Specify which slice of an MDHistoWorkspace to use when plotting. Needs to be a tuple
- and will be interpreted as a list of indices. You need to use ``slice(None)`` to
- select which dimensions to plot. *e.g.* to select the last two axes to plot from a
- 3D volume use ``indices=(5, slice(None), slice(None))`` where the 5 is the bin selected
- for the first axis.
- :param slicepoint: Specify which slice of an MDHistoWorkspace to use when plotting in the dimension units.
- You need to use ``None`` to select which dimension to plot. *e.g.* to select the last
- two axes to plot from a 3D volume use ``slicepoint=(1.0, None, None)`` where the 1.0 is
- the value of the dimension selected for the first axis.
- :param transpose: ``bool`` to transpose the x and y axes of the plotted dimensions of an MDHistoWorkspace
-
- See :meth:`matplotlib.axes.Axes.tricontourf` for more information.
- '''
- transpose = kwargs.pop('transpose', False)
- if isinstance(workspace, mantid.dataobjects.MDHistoWorkspace):
- (normalization, kwargs) = get_normalization(workspace, **kwargs)
- indices, kwargs = get_indices(workspace, **kwargs)
- x_temp, y_temp, z = get_md_data2d_bin_centers(workspace, normalization, indices, transpose)
- x, y = numpy.meshgrid(x_temp, y_temp)
- _setLabels2D(axes, workspace, indices, transpose)
- else:
- (distribution, kwargs) = get_distribution(workspace, **kwargs)
- (x, y, z) = get_matrix_2d_data(workspace, distribution, histogram2D=False, transpose=transpose)
- _setLabels2D(axes, workspace, transpose=transpose)
- # tricontourf segfaults if many z values are not finite
- # https://github.com/matplotlib/matplotlib/issues/10167
- x = x.ravel()
- y = y.ravel()
- z = z.ravel()
- condition = numpy.isfinite(z)
- x = x[condition]
- y = y[condition]
- z = z[condition]
- return axes.tricontourf(x, y, z, *args, **kwargs)
-
-
-def update_colorplot_datalimits(axes, mappables):
- """
- For an colorplot (imshow, pcolor*) plots update the data limits on the axes
- to circumvent bugs in matplotlib
- :param mappables: An iterable of mappable for this axes
- """
- # ax.relim in matplotlib < 2.2 doesn't take into account of images
- # and it doesn't support collections at all as of verison 3 so we'll take
- # over
- if not isinstance(mappables, collections.Iterable):
- mappables = [mappables]
- xmin_all, xmax_all, ymin_all, ymax_all = _LARGEST, _SMALLEST, _LARGEST, _SMALLEST
- for mappable in mappables:
- xmin, xmax, ymin, ymax = get_colorplot_extents(mappable)
- xmin_all, xmax_all = min(xmin_all, xmin), max(xmax_all, xmax)
- ymin_all, ymax_all = min(ymin_all, ymin), max(ymax_all, ymax)
- axes.update_datalim(((xmin_all, ymin_all), (xmax_all, ymax_all)))
- axes.autoscale()
-
-
-def get_colorplot_extents(mappable):
+ ax_properties['yscale'] = 'linear'
+ if ax_properties:
+ for axis in fig.axes:
+ axis.set(**ax_properties)
+ if window_title:
+ fig.canvas.set_window_title(window_title)
+
+ return fig, fig.axes
+
+
+# -----------------------------------------------------------------------------
+# Pricate Methods
+# -----------------------------------------------------------------------------
+def _validate_plot_inputs(workspaces, spectrum_nums, wksp_indices, tiled=False, overplot=False):
+ """Raises a ValueError if any arguments have the incorrect types"""
+ if spectrum_nums is not None and wksp_indices is not None:
+ raise ValueError("Both spectrum_nums and wksp_indices supplied. "
+ "Please supply only 1.")
+
+ if tiled and overplot:
+ raise ValueError("Both tiled and overplot flags set to true. "
+ "Please set only one to true.")
+
+ raise_if_not_sequence(workspaces, 'workspaces', MatrixWorkspace)
+
+ if spectrum_nums is not None:
+ raise_if_not_sequence(spectrum_nums, 'spectrum_nums')
+
+ if wksp_indices is not None:
+ raise_if_not_sequence(wksp_indices, 'wksp_indices')
+
+
+def _add_default_plot_kwargs_from_settings(plot_kwargs, errors):
+ if 'linestyle' not in plot_kwargs:
+ plot_kwargs['linestyle'] = ConfigService.getString("plots.line.Style")
+ if 'linewidth' not in plot_kwargs:
+ plot_kwargs['linewidth'] = float(ConfigService.getString("plots.line.Width"))
+ if 'marker' not in plot_kwargs:
+ plot_kwargs['marker'] = MARKER_MAP[ConfigService.getString("plots.marker.Style")]
+ if 'markersize' not in plot_kwargs:
+ plot_kwargs['markersize'] = float(ConfigService.getString("plots.marker.Size"))
+ if errors:
+ if 'capsize' not in plot_kwargs:
+ plot_kwargs['capsize'] = float(ConfigService.getString("plots.errorbar.Capsize"))
+ if 'capthick' not in plot_kwargs:
+ plot_kwargs['capthick'] = float(ConfigService.getString("plots.errorbar.CapThickness"))
+ if 'errorevery' not in plot_kwargs:
+ plot_kwargs['errorevery'] = int(ConfigService.getString("plots.errorbar.errorEvery"))
+ if 'elinewidth' not in plot_kwargs:
+ plot_kwargs['elinewidth'] = float(ConfigService.getString("plots.errorbar.Width"))
+
+
+def _validate_workspace_names(workspaces):
"""
- Return the extent of the given mappable
- :param mappable: A 2D mappable object
- :return: (left, right, bottom, top)
+ Checks if the workspaces passed into a plotting function are workspace names, and
+ retrieves the workspaces if they are.
+ This function assumes that we do not have a mix of workspaces and workspace names.
+ :param workspaces: A list of workspaces or workspace names
+ :return: A list of workspaces
"""
- if isinstance(mappable, mimage.AxesImage):
- xmin, xmax, ymin, ymax = mappable.get_extent()
- elif isinstance(mappable, mcoll.QuadMesh):
- # coordinates are vertices of the grid
- coords = mappable._coordinates
- xmin, ymin = coords[0][0]
- xmax, ymax = coords[-1][-1]
- elif isinstance(mappable, mcoll.PolyCollection):
- xmin, ymin = mappable._paths[0].get_extents().min
- xmax, ymax = mappable._paths[-1].get_extents().max
+ try:
+ raise_if_not_sequence(workspaces, 'workspaces', string_types)
+ except ValueError:
+ return workspaces
else:
- raise ValueError("Unknown mappable type '{}'".format(type(mappable)))
+ return AnalysisDataService.Instance().retrieveWorkspaces(workspaces, unrollGroups=True)
+
+
+def _do_single_plot(ax, workspaces, errors, set_title, nums, kw, plot_kwargs):
+ # do the plotting
+ plot_fn = ax.errorbar if errors else ax.plot
+ for ws in workspaces:
+ for num in nums:
+ plot_kwargs[kw] = num
+ plot_fn(ws, **plot_kwargs)
+ ax.make_legend()
+ if set_title:
+ title = workspaces[0].name()
+ ax.set_title(title)
+
- return xmin, xmax, ymin, ymax
diff --git a/Framework/PythonInterface/mantid/plots/utility.py b/Framework/PythonInterface/mantid/plots/utility.py
index 4daa1a6d3a8fb78b0dc3a1707645de8762fa6452..e8e7909e771475f2b63a1af6999fb7b5c999eddf 100644
--- a/Framework/PythonInterface/mantid/plots/utility.py
+++ b/Framework/PythonInterface/mantid/plots/utility.py
@@ -7,18 +7,23 @@
# This file is part of the mantid package
from __future__ import absolute_import
-from collections import namedtuple
+# std imports
+import math
+import numpy as np
+import collections
from contextlib import contextmanager
+from enum import Enum
+# 3rd party imports
+from matplotlib.legend import Legend
from matplotlib import cm, __version__ as mpl_version_str
from matplotlib.container import ErrorbarContainer
-from matplotlib.legend import Legend
-
-from enum import Enum
-
+# -----------------------------------------------------------------------------
+# Constants
+# -----------------------------------------------------------------------------
# matplotlib version information
-MPLVersionInfo = namedtuple("MPLVersionInfo", ("major", "minor", "patch"))
+MPLVersionInfo = collections.namedtuple("MPLVersionInfo", ("major", "minor", "patch"))
MATPLOTLIB_VERSION_INFO = MPLVersionInfo._make(map(int, mpl_version_str.split(".")))
@@ -139,6 +144,16 @@ def legend_set_draggable(legend, state, use_blit=False, update='loc'):
getattr(legend, SET_DRAGGABLE_METHOD)(state, use_blit, update)
+def get_current_cmap(object):
+ """Utility function to support varying get_cmap api across
+ the versions of matplotlib we support.
+ """
+ if hasattr(object, "cmap"):
+ return object.cmap
+ else:
+ return object.get_cmap()
+
+
def mpl_version_info():
"""Returns a namedtuple of (major,minor,patch)"""
return MATPLOTLIB_VERSION_INFO
diff --git a/Framework/PythonInterface/mantid/simpleapi.py b/Framework/PythonInterface/mantid/simpleapi.py
index 98b3a9344aea1250779ff0d817d0993df57caa7e..0edcbd34fa2d7e984abe94dd8522263ca11f7931 100644
--- a/Framework/PythonInterface/mantid/simpleapi.py
+++ b/Framework/PythonInterface/mantid/simpleapi.py
@@ -48,8 +48,10 @@ from mantid.kernel.packagesetup import update_sys_paths as _update_sys_paths
# register matplotlib projection
try:
from mantid import plots # noqa
+ from mantid.plots._compatability import plotSpectrum, plotBin # noqa
except ImportError:
pass # matplotlib is unavailable
+
from mantid.kernel._aliases import *
from mantid.api._aliases import *
from mantid.fitfunctions import *
diff --git a/Framework/PythonInterface/plugins/algorithms/Abins.py b/Framework/PythonInterface/plugins/algorithms/Abins.py
index 5f7dda7c45cdb5e328ef94dbfcc9778fd5c30e67..65d0df999e63512f7c48ddef2d321d8e861a84c4 100644
--- a/Framework/PythonInterface/plugins/algorithms/Abins.py
+++ b/Framework/PythonInterface/plugins/algorithms/Abins.py
@@ -115,12 +115,12 @@ class Abins(PythonAlgorithm):
validator=StringListValidator(['Total', 'Incoherent', 'Coherent']),
doc="Scale the partial dynamical structure factors by the scattering cross section.")
+ # Abins is supposed to support excitations up to fourth-order. Order 3 and 4 are currently disabled while the
+ # weighting is being investigated; these intensities were unreasonably large in hydrogenous test cases
self.declareProperty(name="QuantumOrderEventsNumber", defaultValue='1',
- validator=StringListValidator(['1', '2', '3', '4']),
+ validator=StringListValidator(['1', '2']),
doc="Number of quantum order effects included in the calculation "
- "(1 -> FUNDAMENTALS, 2-> first overtone + FUNDAMENTALS + "
- "2nd order combinations, 3-> FUNDAMENTALS + first overtone + second overtone + 2nd "
- "order combinations + 3rd order combinations etc...)")
+ "(1 -> FUNDAMENTALS, 2-> first overtone + FUNDAMENTALS + 2nd order combinations")
self.declareProperty(WorkspaceProperty("OutputWorkspace", '', Direction.Output),
doc="Name to give the output workspace.")
diff --git a/Framework/PythonInterface/plugins/algorithms/EnggCalibrateFull.py b/Framework/PythonInterface/plugins/algorithms/EnggCalibrateFull.py
index e79efe1213f440c028155652fae99ca8503a191b..a432153866935124ba531f3d5ee61897b9c932e5 100644
--- a/Framework/PythonInterface/plugins/algorithms/EnggCalibrateFull.py
+++ b/Framework/PythonInterface/plugins/algorithms/EnggCalibrateFull.py
@@ -364,7 +364,7 @@ class EnggCalibrateFull(PythonAlgorithm):
self.log().notice("Applying calibration on the input workspace")
alg = self.createChildAlgorithm('ApplyCalibration')
alg.setProperty('Workspace', ws)
- alg.setProperty('PositionTable', detPos)
+ alg.setProperty('CalibrationTable', detPos)
alg.execute()
def _V3D_from_spherical(self, R, polar, azimuth):
diff --git a/Framework/PythonInterface/plugins/algorithms/EnggFocus.py b/Framework/PythonInterface/plugins/algorithms/EnggFocus.py
index cae24dff577dc6030ef7edf80c335ac2cf776dd9..585864f2ee27bd6e6ba3d93f266e927de911af2c 100644
--- a/Framework/PythonInterface/plugins/algorithms/EnggFocus.py
+++ b/Framework/PythonInterface/plugins/algorithms/EnggFocus.py
@@ -235,7 +235,7 @@ class EnggFocus(PythonAlgorithm):
"""
alg = self.createChildAlgorithm('ApplyCalibration')
alg.setProperty('Workspace', wks)
- alg.setProperty('PositionTable', detector_positions)
+ alg.setProperty('CalibrationTable', detector_positions)
alg.execute()
def _convert_to_distribution(self, wks):
diff --git a/Framework/PythonInterface/plugins/algorithms/ReflectometryReductionOneLiveData.py b/Framework/PythonInterface/plugins/algorithms/ReflectometryReductionOneLiveData.py
index 2b0cbb143f00890373098c4add0db9093887e62c..ee423bacc348721fc40c046d08a80c6494bbe16f 100644
--- a/Framework/PythonInterface/plugins/algorithms/ReflectometryReductionOneLiveData.py
+++ b/Framework/PythonInterface/plugins/algorithms/ReflectometryReductionOneLiveData.py
@@ -48,13 +48,17 @@ class ReflectometryReductionOneLiveData(DataProcessorAlgorithm):
'DetectorCorrectionType', 'WavelengthMin', 'WavelengthMax', 'I0MonitorIndex',
'MonitorBackgroundWavelengthMin', 'MonitorBackgroundWavelengthMax',
'MonitorIntegrationWavelengthMin', 'MonitorIntegrationWavelengthMax',
- 'NormalizeByIntegratedMonitors', 'Params', 'StartOverlap', 'EndOverlap',
+ 'NormalizeByIntegratedMonitors',
+ 'SubtractBackground', 'BackgroundProcessingInstructions',
+ 'BackgroundCalculationMethod', 'DegreeOfPolynomial', 'CostFunction',
+ 'Params', 'StartOverlap', 'EndOverlap',
'ScaleRHSWorkspace', 'TransmissionProcessingInstructions',
'CorrectionAlgorithm', 'Polynomial', 'C0', 'C1',
'MomentumTransferMin', 'MomentumTransferStep', 'MomentumTransferMax',
'ScaleFactor', 'PolarizationAnalysis',
'FloodCorrection', 'FloodWorkspace', 'Debug',
- 'OutputWorkspace']
+ 'TimeInterval', 'LogValueInterval', 'LogName', 'UseNewFilterAlgorithm',
+ 'ReloadInvalidWorkspaces', 'GroupTOFWorkspaces', 'OutputWorkspace']
self.copyProperties('ReflectometryISISLoadAndProcess', self._child_properties)
def PyExec(self):
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ConvertMultipleRunsToSingleCrystalMD.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ConvertMultipleRunsToSingleCrystalMD.py
index f99fe0c9961228c13ae00f062b59955fcc75b5db..6697f3ab61727a69190770f1b909ff9c7092df2a 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ConvertMultipleRunsToSingleCrystalMD.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ConvertMultipleRunsToSingleCrystalMD.py
@@ -205,7 +205,7 @@ class ConvertMultipleRunsToSingleCrystalMD(DataProcessorAlgorithm):
if self._load_inst:
LoadInstrument(Workspace=ws_name, Filename=self.getProperty("LoadInstrument").value, RewriteSpectraMap=False)
if self._apply_cal:
- ApplyCalibration(Workspace=ws_name, PositionTable=self.getProperty("ApplyCalibration").value)
+ ApplyCalibration(Workspace=ws_name, CalibrationTable=self.getProperty("ApplyCalibration").value)
if self._detcal:
LoadIsawDetCal(InputWorkspace=ws_name, Filename=self.getProperty("DetCal").value)
if self._copy_params:
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLEnergyTransfer.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLEnergyTransfer.py
index 1d6ea188f8fa1d253ee3193c4c83a361330e614c..e0b6b5b75901b200308f8aae4b28a1d0a2b86735 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLEnergyTransfer.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLEnergyTransfer.py
@@ -400,6 +400,11 @@ class IndirectILLEnergyTransfer(PythonAlgorithm):
self._reduce_one_wing_doppler(self._ws)
GroupWorkspaces(InputWorkspaces=[self._ws],OutputWorkspace=self._red_ws)
+ if self._normalise_to == 'Monitor':
+ for ws in mtd[self._red_ws]:
+ AddSampleLog(Workspace=ws, LogName="NormalisedTo", LogType="String",
+ LogText="Monitor", EnableLogging=False)
+
self.setProperty('OutputWorkspace',self._red_ws)
def _create_elastic_channel_ws(self, epp_ws, run, epp_equator_ws=None):
@@ -608,6 +613,8 @@ class IndirectILLEnergyTransfer(PythonAlgorithm):
RebinToWorkspace(WorkspaceToRebin=ws, WorkspaceToMatch=rebin_ws, OutputWorkspace=ws)
if self._group_detectors:
self._do_group_detectors(ws)
+ if self._normalise_to == 'Monitor':
+ mtd[ws].setDistribution(True)
GroupWorkspaces(InputWorkspaces=[ws],OutputWorkspace=self._red_ws)
DeleteWorkspaces([rebin_ws])
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionFWS.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionFWS.py
index 08b31530fd2e0e3af78f57193c067461e5a37bbb..df31ae935bb83c2362accb35864522524ceb9785 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionFWS.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionFWS.py
@@ -138,6 +138,12 @@ class IndirectILLReductionFWS(PythonAlgorithm):
self.declareProperty(name='DiscardSingleDetectors', defaultValue=False,
doc='Whether to discard the spectra of single detectors.')
+ self.declareProperty(name='ManualInelasticPeakChannels', defaultValue=[-1,-1],
+ doc='The channel indices for the inelastic peak positions in the beginning '
+ 'and in the end of the spectra; by default the maxima of the monitor '
+ 'spectrum will be used for this. The intensities will be integrated symmetrically '
+ 'around each peak.')
+
def validateInputs(self):
issues = dict()
@@ -146,6 +152,16 @@ class IndirectILLReductionFWS(PythonAlgorithm):
issues['CalibrationRun'] = 'Calibration runs are required, ' \
'if background for calibration is given.'
+ if not self.getProperty('ManualInelasticPeakChannels').isDefault:
+ peaks = self.getProperty('ManualInelasticPeakChannels').value
+ if len(peaks) != 2:
+ issues['ManualInelasticPeakChannels'] = 'Invalid value for peak channels, ' \
+ 'provide two comma separated positive integers.'
+ elif peaks[0] >= peaks[1]:
+ issues['ManualInelasticPeakChannels'] = 'First peak channel must be less than the second'
+ elif peaks[0] <= 0:
+ issues['ManualInelasticPeakChannels'] = 'Non negative integers are required'
+
return issues
def setUp(self):
@@ -219,14 +235,23 @@ class IndirectILLReductionFWS(PythonAlgorithm):
return files
- @staticmethod
- def _ifws_peak_bins(ws):
+ def _ifws_peak_bins(self, ws):
'''
- Gives the bin indices of the first and last peaks of monitors from the sample logs
+ Gives the bin indices of the first and last inelastic peaks
+ By default they are taken from the maxima of the monitor spectrum
+ Or they can be specified manually as input parameters
@param ws :: input workspace
return :: [imin,imax]
'''
-
+ if not self.getProperty('ManualInelasticPeakChannels').isDefault:
+ peak_channels = self.getProperty('ManualInelasticPeakChannels').value
+ blocksize = mtd[ws].blocksize()
+ if peak_channels[1] >= blocksize:
+ raise RuntimeError('Manual peak channel {0} is out of range {1}'.format(peak_channels[1], blocksize))
+ else:
+ AddSampleLogMultiple(Workspace=ws, LogNames=['ManualInelasticLeftPeak', 'ManualInelasticRightPeak'],
+ LogValues=str(peak_channels[0])+','+str(peak_channels[1]))
+ return peak_channels
run = mtd[ws].getRun()
if not run.hasProperty('MonitorLeftPeak') or not run.hasProperty('MonitorRightPeak'):
raise RuntimeError('Unable to retrieve the monitor peak information from the sample logs.')
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionQENS.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionQENS.py
index 55d68c6cb4d6077480d6e47658af3d83130d3e98..47dc47ed56aa8fc8ed00c44d48a17a76516ec312 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionQENS.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionQENS.py
@@ -340,8 +340,11 @@ class IndirectILLReductionQENS(PythonAlgorithm):
GroupWorkspaces(InputWorkspaces=self._ws_list,OutputWorkspace=self._red_ws)
- # unhide the final workspaces, i.e. remove __ prefix
for ws in mtd[self._red_ws]:
+ if ws.getRun().hasProperty("NormalisedTo"):
+ if ws.getRun().getLogData("NormalisedTo").value == "Monitor":
+ ws.setDistribution(True)
+ # unhide the final workspaces, i.e. remove __ prefix
RenameWorkspace(InputWorkspace=ws,OutputWorkspace=ws.getName()[2:])
self.setProperty('OutputWorkspace',self._red_ws)
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py
index 31afb2d9033818ce4f4987277e05655448fa11f3..71806c24a105be8c639a3cce5b905496b9139eba 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py
@@ -9,7 +9,7 @@
from __future__ import (absolute_import, division, print_function)
from mantid.api import (AlgorithmFactory, AnalysisDataService, DataProcessorAlgorithm,
- PropertyMode, WorkspaceGroup, WorkspaceProperty)
+ WorkspaceGroup)
from mantid.simpleapi import (LoadEventNexus, LoadNexus, MergeRuns, RenameWorkspace)
@@ -30,9 +30,13 @@ class Prop:
QMAX = 'MomentumTransferMax'
GROUP_TOF = 'GroupTOFWorkspaces'
RELOAD = 'ReloadInvalidWorkspaces'
+ DEBUG = 'Debug'
OUTPUT_WS = 'OutputWorkspace'
OUTPUT_WS_BINNED = 'OutputWorkspaceBinned'
OUTPUT_WS_LAM = 'OutputWorkspaceWavelength'
+ OUTPUT_WS_FIRST_TRANS = 'OutputWorkspaceFirstTransmission'
+ OUTPUT_WS_SECOND_TRANS = 'OutputWorkspaceSecondTransmission'
+ OUTPUT_WS_TRANS = 'OutputWorkspaceTransmission'
class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
@@ -65,41 +69,12 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
def PyInit(self):
"""Initialize the input and output properties of the algorithm."""
- mandatoryInputRuns = CompositeValidator()
- mandatoryInputRuns.add(StringArrayMandatoryValidator())
- lenValidator = StringArrayLengthValidator()
- lenValidator.setLengthMin(1)
- mandatoryInputRuns.add(lenValidator)
- self.declareProperty(StringArrayProperty(Prop.RUNS,
- values=[],
- validator=mandatoryInputRuns),
- doc='A list of run numbers or workspace names for the input runs. '
- 'Multiple runs will be summed before reduction.')
- self.declareProperty(StringArrayProperty(Prop.FIRST_TRANS_RUNS,
- values=[]),
- doc='A list of run numbers or workspace names for the first transmission run. '
- 'Multiple runs will be summed before reduction.')
- self.declareProperty(StringArrayProperty(Prop.SECOND_TRANS_RUNS,
- values=[]),
- doc='A list of run numbers or workspace names for the second transmission run. '
- 'Multiple runs will be summed before reduction.')
- self._declareSliceAlgorithmProperties()
- self._declareReductionAlgorithmProperties()
- self.declareProperty(Prop.GROUP_TOF, True, doc='If true, group the input TOF workspace')
- self.declareProperty(Prop.RELOAD, True,
- doc='If true, reload input workspaces if they are of the incorrect type')
- self.declareProperty(WorkspaceProperty(Prop.OUTPUT_WS, '',
- optional=PropertyMode.Optional,
- direction=Direction.Output),
- doc='The output workspace, or workspace group if sliced.')
- self.declareProperty(WorkspaceProperty(Prop.OUTPUT_WS_BINNED, '',
- optional=PropertyMode.Optional,
- direction=Direction.Output),
- doc='The binned output workspace, or workspace group if sliced.')
- self.declareProperty(WorkspaceProperty(Prop.OUTPUT_WS_LAM, '',
- optional=PropertyMode.Optional,
- direction=Direction.Output),
- doc='The output workspace in wavelength, or workspace group if sliced.')
+ self._reduction_properties = [] # cached list of properties copied from child alg
+ self._declareRunProperties()
+ self._declareSlicingProperties()
+ self._declareReductionProperties()
+ self._declareTransmissionProperties()
+ self._declareOutputProperties()
def PyExec(self):
"""Execute the algorithm."""
@@ -112,17 +87,29 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
secondTransRuns = self.getProperty(Prop.SECOND_TRANS_RUNS).value
secondTransWorkspaces = self._getInputWorkspaces(secondTransRuns, True)
# Combine multiple input runs, if required
- input_workspace = self._sumWorkspaces(inputWorkspaces, False)
- first_trans_workspace = self._sumWorkspaces(firstTransWorkspaces, True)
- second_trans_workspace = self._sumWorkspaces(secondTransWorkspaces, True)
+ inputWorkspace = self._sumWorkspaces(inputWorkspaces, False)
+ firstTransWorkspace = self._sumWorkspaces(firstTransWorkspaces, True)
+ secondTransWorkspace = self._sumWorkspaces(secondTransWorkspaces, True)
# Slice the input workspace, if required
- input_workspace = self._sliceWorkspace(input_workspace)
+ inputWorkspace = self._sliceWorkspace(inputWorkspace)
# Perform the reduction
- alg = self._reduce(input_workspace, first_trans_workspace, second_trans_workspace)
+ alg = self._reduce(inputWorkspace, firstTransWorkspace, secondTransWorkspace)
+ # Set outputs and tidy TOF workspaces into a group
self._finalize(alg)
- if len(inputWorkspaces) >= 2:
- inputWorkspaces.append(input_workspace)
- self._group_workspaces(inputWorkspaces, "TOF")
+ self._groupTOFWorkspaces(inputWorkspaces)
+
+ def _groupTOFWorkspaces(self, inputWorkspaces):
+ """Put all of the TOF workspaces into a group called 'TOF' to hide some noise
+ for the user."""
+ if not self.getProperty(Prop.GROUP_TOF).value:
+ return
+ tofWorkspaces = set(inputWorkspaces)
+ # If slicing, also group the monitor workspace (note that there is only one
+ # input run when slicing)
+ if self._slicingEnabled():
+ tofWorkspaces.add(_monitorWorkspace(inputWorkspaces[0]))
+ # Create the group
+ self._group_workspaces(tofWorkspaces, "TOF")
def validateInputs(self):
"""Return a dictionary containing issues found in properties."""
@@ -131,15 +118,41 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
issues[Prop.SLICE] = "Cannot perform slicing when summing multiple input runs"
return issues
- def _declareSliceAlgorithmProperties(self):
+ def _declareRunProperties(self):
+ mandatoryInputRuns = CompositeValidator()
+ mandatoryInputRuns.add(StringArrayMandatoryValidator())
+ lenValidator = StringArrayLengthValidator()
+ lenValidator.setLengthMin(1)
+ mandatoryInputRuns.add(lenValidator)
+ # Add property for the input runs
+ self.declareProperty(StringArrayProperty(Prop.RUNS,
+ values=[],
+ validator=mandatoryInputRuns),
+ doc='A list of run numbers or workspace names for the input runs. '
+ 'Multiple runs will be summed before reduction.')
+ # Add properties from child algorithm
+ properties = [
+ 'ThetaIn', 'ThetaLogName',
+ ]
+ self.copyProperties('ReflectometryReductionOneAuto', properties)
+ self._reduction_properties += properties
+ # Add properties for settings to apply to input runs
+ self.declareProperty(Prop.RELOAD, True,
+ doc='If true, reload input workspaces if they are of the incorrect type')
+ self.declareProperty(Prop.GROUP_TOF, True, doc='If true, group the TOF workspaces')
+
+ def _declareSlicingProperties(self):
"""Copy properties from the child slicing algorithm and add our own custom ones"""
self.declareProperty(Prop.SLICE, False, doc='If true, slice the input workspace')
+ self.setPropertyGroup(Prop.SLICE, 'Slicing')
+ # Convenience variables for conditional properties
whenSliceEnabled = EnabledWhenProperty(Prop.SLICE, PropertyCriterion.IsEqualTo, "1")
self._slice_properties = ['TimeInterval', 'LogName', 'LogValueInterval', 'UseNewFilterAlgorithm']
self.copyProperties('ReflectometrySliceEventWorkspace', self._slice_properties)
for property in self._slice_properties:
self.setPropertySettings(property, whenSliceEnabled)
+ self.setPropertyGroup(property, 'Slicing')
self.declareProperty(name=Prop.NUMBER_OF_SLICES,
defaultValue=Property.EMPTY_INT,
@@ -147,22 +160,52 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
direction=Direction.Input,
doc='The number of uniform-length slices to slice the input workspace into')
self.setPropertySettings(Prop.NUMBER_OF_SLICES, whenSliceEnabled)
+ self.setPropertyGroup(Prop.NUMBER_OF_SLICES, 'Slicing')
- def _declareReductionAlgorithmProperties(self):
- """Copy properties from the child reduction algorithm"""
- self._reduction_properties = [
- 'ThetaIn', 'ThetaLogName',
+ def _declareReductionProperties(self):
+ properties = [
'SummationType', 'ReductionType', 'IncludePartialBins',
'AnalysisMode', 'ProcessingInstructions', 'CorrectDetectors',
'DetectorCorrectionType', 'WavelengthMin', 'WavelengthMax', 'I0MonitorIndex',
'MonitorBackgroundWavelengthMin', 'MonitorBackgroundWavelengthMax',
'MonitorIntegrationWavelengthMin', 'MonitorIntegrationWavelengthMax',
- 'NormalizeByIntegratedMonitors', 'Params', 'StartOverlap', 'EndOverlap',
- 'ScaleRHSWorkspace', 'TransmissionProcessingInstructions', 'CorrectionAlgorithm', 'Polynomial', 'C0', 'C1',
- 'MomentumTransferMin', 'MomentumTransferStep', 'MomentumTransferMax', 'ScaleFactor',
- 'PolarizationAnalysis', 'FloodCorrection',
- 'FloodWorkspace', 'Debug']
- self.copyProperties('ReflectometryReductionOneAuto', self._reduction_properties)
+ 'SubtractBackground', 'BackgroundProcessingInstructions', 'BackgroundCalculationMethod',
+ 'DegreeOfPolynomial', 'CostFunction',
+ 'NormalizeByIntegratedMonitors', 'PolarizationAnalysis',
+ 'FloodCorrection', 'FloodWorkspace',
+ 'CorrectionAlgorithm', 'Polynomial', 'C0', 'C1'
+ ]
+ self.copyProperties('ReflectometryReductionOneAuto', properties)
+ self._reduction_properties += properties
+
+ def _declareTransmissionProperties(self):
+ # Add input transmission run properties
+ self.declareProperty(StringArrayProperty(Prop.FIRST_TRANS_RUNS,
+ values=[]),
+ doc='A list of run numbers or workspace names for the first transmission run. '
+ 'Multiple runs will be summed before reduction.')
+ self.setPropertyGroup(Prop.FIRST_TRANS_RUNS, 'Transmission')
+ self.declareProperty(StringArrayProperty(Prop.SECOND_TRANS_RUNS,
+ values=[]),
+ doc='A list of run numbers or workspace names for the second transmission run. '
+ 'Multiple runs will be summed before reduction.')
+ self.setPropertyGroup(Prop.SECOND_TRANS_RUNS, 'Transmission')
+ # Add properties copied from child algorithm
+ properties = [
+ 'Params', 'StartOverlap', 'EndOverlap',
+ 'ScaleRHSWorkspace', 'TransmissionProcessingInstructions'
+ ]
+ self.copyProperties('ReflectometryReductionOneAuto', properties)
+ self._reduction_properties += properties
+
+ def _declareOutputProperties(self):
+ properties = [Prop.DEBUG,
+ 'MomentumTransferMin', 'MomentumTransferStep', 'MomentumTransferMax',
+ 'ScaleFactor',
+ Prop.OUTPUT_WS_BINNED, Prop.OUTPUT_WS, Prop.OUTPUT_WS_LAM,
+ Prop.OUTPUT_WS_TRANS, Prop.OUTPUT_WS_FIRST_TRANS, Prop.OUTPUT_WS_SECOND_TRANS]
+ self.copyProperties('ReflectometryReductionOneAuto', properties)
+ self._reduction_properties += properties
def _getInputWorkspaces(self, runs, isTrans):
"""Convert the given run numbers into real workspace names. Uses workspaces from
@@ -240,17 +283,18 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
def _collapse_workspace_groups(self, workspaces):
"""Given a list of workspaces, which themselves could be groups of workspaces,
return a new list of workspaces which are TOF"""
- ungrouped_workspaces = []
+ ungrouped_workspaces = set([])
delete_ws_group_flag = True
for ws_name in workspaces:
ws = AnalysisDataService.retrieve(ws_name)
if isinstance(ws, WorkspaceGroup):
- ungrouped_workspaces += self._collapse_workspace_groups(ws.getNames())
+ ungrouped_workspaces = ungrouped_workspaces.union(
+ self._collapse_workspace_groups(ws.getNames()))
if delete_ws_group_flag is True:
AnalysisDataService.remove(ws_name)
else:
if (ws.getAxis(0).getUnit().unitID()) == 'TOF':
- ungrouped_workspaces.append(ws_name)
+ ungrouped_workspaces.add(ws_name)
else:
# Do not remove the workspace group from the ADS if a non-TOF workspace exists
delete_ws_group_flag = False
@@ -261,7 +305,7 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
Groups all the given workspaces into a group with the given name. If the group
already exists it will add them to that group.
"""
- if not self.getProperty(Prop.GROUP_TOF).value:
+ if len(workspaces) < 1:
return
workspaces = self._collapse_workspace_groups(workspaces)
@@ -279,12 +323,14 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
ws_group.add(ws)
else:
alg = self.createChildAlgorithm("GroupWorkspaces")
- alg.setProperty("InputWorkspaces", workspaces)
+ alg.setProperty("InputWorkspaces", list(workspaces))
alg.setProperty("OutputWorkspace", output_ws_name)
alg.execute()
ws_group = alg.getProperty("OutputWorkspace").value
- AnalysisDataService.addOrReplace(output_ws_name, ws_group)
- return ws_group
+ # We can't add the group as an output property or it will duplicate
+ # the history for the contained workspaces, so add it directly to
+ # the ADS
+ AnalysisDataService.addOrReplace(output_ws_name, ws_group)
def _renameWorkspaceBasedOnRunNumber(self, workspace_name, isTrans):
"""Rename the given workspace based on its run number and a standard prefix"""
@@ -320,20 +366,19 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
return workspaces[0]
workspaces_without_prefixes = [self._removePrefix(ws, isTrans) for ws in workspaces]
concatenated_names = "+".join(workspaces_without_prefixes)
- summed = self._prefixedName(concatenated_names, isTrans)
- self.log().information('Summing workspaces' + " ".join(workspaces) + ' into ' + summed)
- MergeRuns(InputWorkspaces=", ".join(workspaces), OutputWorkspace=summed)
+ summed_name = self._prefixedName(concatenated_names, isTrans)
+ self.log().information('Summing workspaces' + " ".join(workspaces) + ' into ' + summed_name)
+ summed_ws = MergeRuns(InputWorkspaces=", ".join(workspaces), OutputWorkspace=summed_name)
# The reduction algorithm sets the output workspace names from the run number,
# which by default is just the first run. Set it to the concatenated name,
# e.g. 13461+13462
- ws = AnalysisDataService.retrieve(summed)
- if isinstance(ws, WorkspaceGroup):
- for workspaceName in ws.getNames():
+ if isinstance(summed_ws, WorkspaceGroup):
+ for workspaceName in summed_ws.getNames():
grouped_ws = AnalysisDataService.retrieve(workspaceName)
grouped_ws.run().addProperty('run_number', concatenated_names, True)
else:
- ws.run().addProperty('run_number', concatenated_names, True)
- return summed
+ summed_ws.run().addProperty('run_number', concatenated_names, True)
+ return summed_name
def _slicingEnabled(self):
return self.getProperty(Prop.SLICE).value
@@ -374,35 +419,30 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
self._setUniformNumberOfSlices(alg, input_workspace)
self._setSliceStartStopTimes(alg, input_workspace)
alg.execute()
+ return alg.getProperty("OutputWorkspace").value
def _sliceWorkspace(self, workspace):
"""If slicing has been requested, slice the input workspace, otherwise
return it unchanged"""
if not self._slicingEnabled():
return workspace
+ # Perform the slicing
sliced_workspace_name = self._getSlicedWorkspaceGroupName(workspace)
self.log().information('Slicing workspace ' + workspace + ' into ' + sliced_workspace_name)
- self._runSliceAlgorithm(workspace, sliced_workspace_name)
+ workspace = self._runSliceAlgorithm(workspace, sliced_workspace_name)
return sliced_workspace_name
def _getSlicedWorkspaceGroupName(self, workspace):
return workspace + '_sliced'
- def _setChildAlgorithmPropertyIfProvided(self, alg, property_name):
- """Set the given property on the given algorithm if it is set in our
- inputs. Leave it unset otherwise."""
- if not self.getProperty(property_name).isDefault:
- alg.setProperty(property_name, self.getPropertyValue(property_name))
-
def _reduce(self, input_workspace, first_trans_workspace, second_trans_workspace):
"""Run the child algorithm to do the reduction. Return the child algorithm."""
self.log().information('Running ReflectometryReductionOneAuto on ' + input_workspace)
alg = self.createChildAlgorithm("ReflectometryReductionOneAuto")
+ # Set properties that we copied directly from the child
for property in self._reduction_properties:
alg.setProperty(property, self.getPropertyValue(property))
- self._setChildAlgorithmPropertyIfProvided(alg, Prop.OUTPUT_WS)
- self._setChildAlgorithmPropertyIfProvided(alg, Prop.OUTPUT_WS_BINNED)
- self._setChildAlgorithmPropertyIfProvided(alg, Prop.OUTPUT_WS_LAM)
+ # Set properties that we could not take directly from the child
alg.setProperty("InputWorkspace", input_workspace)
alg.setProperty("FirstTransmissionRun", first_trans_workspace)
alg.setProperty("SecondTransmissionRun", second_trans_workspace)
@@ -419,32 +459,43 @@ class ReflectometryISISLoadAndProcess(DataProcessorAlgorithm):
else:
return workspace
+ def _hasTransmissionRuns(self):
+ return not self.getProperty(Prop.FIRST_TRANS_RUNS).isDefault
+
+ def _isDebug(self):
+ return not self.getProperty(Prop.DEBUG).isDefault
+
def _finalize(self, child_alg):
"""Set our output properties from the results in the given child algorithm"""
+ # Set the main workspace outputs
self._setOutputProperty(Prop.OUTPUT_WS, child_alg)
self._setOutputProperty(Prop.OUTPUT_WS_BINNED, child_alg)
self._setOutputProperty(Prop.OUTPUT_WS_LAM, child_alg)
+ # Set the Q params as outputs if they were not specified as inputs
self._setOutputPropertyIfInputNotSet(Prop.QMIN, child_alg)
self._setOutputPropertyIfInputNotSet(Prop.QSTEP, child_alg)
self._setOutputPropertyIfInputNotSet(Prop.QMAX, child_alg)
+ # Set the transmission workspace outputs
+ self._setOutputProperty(Prop.OUTPUT_WS_TRANS, child_alg)
+ self._setOutputProperty(Prop.OUTPUT_WS_FIRST_TRANS, child_alg)
+ self._setOutputProperty(Prop.OUTPUT_WS_SECOND_TRANS, child_alg)
def _setOutputProperty(self, property_name, child_alg):
"""Set the given output property from the result in the given child algorithm,
if it exists in the child algorithm's outputs"""
- value = child_alg.getPropertyValue(property_name)
- if value:
- self.setPropertyValue(property_name, value)
- self.setProperty(property_name, child_alg.getProperty(property_name).value)
+ value_name = child_alg.getPropertyValue(property_name)
+ if value_name:
+ self.setPropertyValue(property_name, value_name)
+ value = child_alg.getProperty(property_name).value
+ if value:
+ self.setProperty(property_name, value)
def _setOutputPropertyIfInputNotSet(self, property_name, child_alg):
"""Set the given output property from the result in the given child algorithm,
if it was not set as an input to this algorithm and if it exists in the
child algorithm's outputs"""
if self.getProperty(property_name).isDefault:
- value = child_alg.getPropertyValue(property_name)
- if value:
- self.setPropertyValue(property_name, value)
- self.setProperty(property_name, child_alg.getProperty(property_name).value)
+ self._setOutputProperty(property_name, child_alg)
def _throwIfNotValidReflectometryEventWorkspace(workspace_name):
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SANSILLReduction.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SANSILLReduction.py
index b3c39257ac7f175ca6f597af453f1530b131213c..6a92c5804ba71753cebaa673707ce0312fa23d9f 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SANSILLReduction.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SANSILLReduction.py
@@ -338,15 +338,6 @@ class SANSILLReduction(PythonAlgorithm):
Processes the sample
@param ws: input workspace
"""
- reference_ws = self.getProperty('ReferenceInputWorkspace').value
- coll_ws = None
- if reference_ws:
- if not self._check_processed_flag(reference_ws, 'Sample'):
- self.log().warning('Reference input workspace is not processed as sample.')
- Divide(LHSWorkspace=ws, RHSWorkspace=reference_ws, OutputWorkspace=ws, WarnOnZeroDivide=False)
- Scale(InputWorkspace=ws, Factor=self.getProperty('WaterCrossSection').value, OutputWorkspace=ws)
- self._mask(ws, reference_ws)
- coll_ws = reference_ws
sensitivity_in = self.getProperty('SensitivityInputWorkspace').value
if sensitivity_in:
if not self._check_processed_flag(sensitivity_in, 'Sensitivity'):
@@ -362,16 +353,62 @@ class SANSILLReduction(PythonAlgorithm):
DeleteWorkspace(flux_ws)
else:
Divide(LHSWorkspace=ws, RHSWorkspace=flux_in, OutputWorkspace=ws, WarnOnZeroDivide=False)
- if coll_ws:
- self._check_distances_match(mtd[ws], coll_ws)
- if mtd[ws].getRun().hasProperty('collimation.actual_position') and coll_ws.getRun().hasProperty('collimation.actual_position'):
- sample_coll = mtd[ws].getRun().getLogData('collimation.actual_position').value
- ref_coll = coll_ws.getRun().getLogData('collimation.actual_position').value
- flux_factor = (sample_coll ** 2) / (ref_coll ** 2)
- self.log().notice('Flux factor is: ' + str(flux_factor))
- Scale(InputWorkspace=ws, Factor=flux_factor, OutputWorkspace=ws)
- ReplaceSpecialValues(InputWorkspace=ws, OutputWorkspace=ws,
- NaNValue=0., NaNError=0., InfinityValue=0., InfinityError=0.)
+ AddSampleLog(Workspace=ws, LogText='True', LogType='String', LogName='NormalisedByFlux')
+ self._do_rescale_flux(ws, flux_in)
+ reference_ws = self.getProperty('ReferenceInputWorkspace').value
+ if reference_ws:
+ if not self._check_processed_flag(reference_ws, 'Sample'):
+ self.log().warning('Reference input workspace is not processed as sample.')
+ Divide(LHSWorkspace=ws, RHSWorkspace=reference_ws, OutputWorkspace=ws, WarnOnZeroDivide=False)
+ Scale(InputWorkspace=ws, Factor=self.getProperty('WaterCrossSection').value, OutputWorkspace=ws)
+ self._mask(ws, reference_ws)
+ self._rescale_flux(ws, reference_ws)
+ ReplaceSpecialValues(InputWorkspace=ws, OutputWorkspace=ws,
+ NaNValue=0., NaNError=0., InfinityValue=0., InfinityError=0.)
+
+ def _rescale_flux(self, ws, ref_ws):
+ """
+ This adjusts the absolute scale after normalising by water
+ If both sample and water runs are normalised by flux, there is nothing to do
+ If one is normalised, the other is not, we log a warning
+ If neither is normalised by flux, we have to rescale by the factor
+ @param ws : the workspace to scale (sample)
+ @param ref_ws : the reference workspace (water)
+ """
+ message = 'Sample and water runs are not consistent in terms of flux normalisation; ' \
+ 'the absolute scale will not be correct. ' \
+ 'Make sure they are either both normalised or both not normalised by flux.' \
+ 'Consider specifying the sample flux also to water reduction.' \
+ 'Even if it would be at different distance, it will be rescaled correctly.'
+ run = mtd[ws].getRun()
+ run_ref = ref_ws.getRun()
+ has_log = run.hasProperty('NormalisedByFlux')
+ has_log_ref = run_ref.hasProperty('NormalisedByFlux')
+ if has_log != has_log_ref:
+ raise RuntimeError(message)
+ if has_log and has_log_ref:
+ log_val = run.getLogData('NormalisedByFlux').value
+ log_val_ref = run_ref.getLogData('NormalisedByFlux').value
+ if log_val != log_val_ref:
+ raise RuntimeError(message)
+ elif log_val == 'False':
+ self._do_rescale_flux(ws, ref_ws)
+ else:
+ self._do_rescale_flux(ws, ref_ws)
+
+ def _do_rescale_flux(self, ws, ref_ws):
+ """
+ Scales ws by the flux factor wrt the reference
+ @ws : input workspace to scale (sample)
+ @ref_ws : reference workspace (water)
+ """
+ self._check_distances_match(mtd[ws], ref_ws)
+ sample_l2 = mtd[ws].getRun().getLogData('L2').value
+ ref_l2 = ref_ws.getRun().getLogData('L2').value
+ flux_factor = (sample_l2 ** 2) / (ref_l2 ** 2)
+ self.log().notice('Flux factor is: ' + str(flux_factor))
+ Scale(InputWorkspace=ws, Factor=flux_factor, OutputWorkspace=ws)
+>>>>>>> master
def _apply_absorber(self, ws, absorber_ws):
"""
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SingleCrystalDiffuseReduction.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SingleCrystalDiffuseReduction.py
index 69aa09e2b9f57538e9defe8d594e78631f95f172..aff9888c391d24615f7183634b7378a34dbec5e3 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SingleCrystalDiffuseReduction.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SingleCrystalDiffuseReduction.py
@@ -334,7 +334,7 @@ class SingleCrystalDiffuseReduction(DataProcessorAlgorithm):
if self._load_inst:
LoadInstrument(Workspace=ws_name, Filename=self.getProperty("LoadInstrument").value, RewriteSpectraMap=False)
if self._apply_cal:
- ApplyCalibration(Workspace=ws_name, PositionTable=self.getProperty("ApplyCalibration").value)
+ ApplyCalibration(Workspace=ws_name, CalibrationTable=self.getProperty("ApplyCalibration").value)
if self._detcal:
LoadIsawDetCal(InputWorkspace=ws_name, Filename=self.getProperty("DetCal").value)
if self._copy_params:
diff --git a/Framework/PythonInterface/test/python/mantid/plots/CMakeLists.txt b/Framework/PythonInterface/test/python/mantid/plots/CMakeLists.txt
index e62034a5b8d1aa84d48c8f19bc094de220ebbef2..957c771ca67aa1011562bd2e4fa14b70682a40f9 100644
--- a/Framework/PythonInterface/test/python/mantid/plots/CMakeLists.txt
+++ b/Framework/PythonInterface/test/python/mantid/plots/CMakeLists.txt
@@ -3,8 +3,9 @@ add_subdirectory(modest_image)
# mantid.dataobjects tests
set(TEST_PY_FILES
- helperfunctionsTest.py plotfunctionsTest.py plotfunctions3DTest.py
- plots__init__Test.py ScalesTest.py UtilityTest.py
+ datafunctionsTest.py axesfunctionsTest.py axesfunctions3DTest.py
+ plotfunctionsTest.py plots__init__Test.py ScalesTest.py UtilityTest.py
+ compatabilityTest.py
)
check_tests_valid(${CMAKE_CURRENT_SOURCE_DIR} ${TEST_PY_FILES})
diff --git a/Framework/PythonInterface/test/python/mantid/plots/plotfunctions3DTest.py b/Framework/PythonInterface/test/python/mantid/plots/axesfunctions3DTest.py
similarity index 99%
rename from Framework/PythonInterface/test/python/mantid/plots/plotfunctions3DTest.py
rename to Framework/PythonInterface/test/python/mantid/plots/axesfunctions3DTest.py
index e86c760202181c829b3ab4ab9e7fdf11524369bf..df4f9d3a8cc0036acaa84a9aca6f2b36306d73b0 100644
--- a/Framework/PythonInterface/test/python/mantid/plots/plotfunctions3DTest.py
+++ b/Framework/PythonInterface/test/python/mantid/plots/axesfunctions3DTest.py
@@ -13,7 +13,7 @@ import matplotlib.pyplot as plt
import unittest
import mantid.api
-import mantid.plots.plotfunctions3D as funcs
+import mantid.plots.axesfunctions3D as funcs
from mantid.kernel import config
from mantid.simpleapi import CreateWorkspace, DeleteWorkspace, CreateMDHistoWorkspace,\
ConjoinWorkspaces
diff --git a/Framework/PythonInterface/test/python/mantid/plots/axesfunctionsTest.py b/Framework/PythonInterface/test/python/mantid/plots/axesfunctionsTest.py
new file mode 100644
index 0000000000000000000000000000000000000000..03f47dadf67d4bead48ef83bd7494b311fec0dfc
--- /dev/null
+++ b/Framework/PythonInterface/test/python/mantid/plots/axesfunctionsTest.py
@@ -0,0 +1,232 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+from __future__ import (absolute_import, division, print_function)
+
+import matplotlib
+import unittest
+
+matplotlib.use('AGG') # noqa
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+import mantid.api
+import mantid.plots.axesfunctions as funcs
+from mantid.plots.utility import MantidAxType
+from mantid.kernel import config
+from mantid.simpleapi import (CreateWorkspace, CreateEmptyTableWorkspace, DeleteWorkspace,
+ CreateMDHistoWorkspace, ConjoinWorkspaces, AddTimeSeriesLog)
+
+
+class PlotFunctionsTest(unittest.TestCase):
+
+ @classmethod
+ def setUpClass(cls):
+ cls.g1da = config['graph1d.autodistribution']
+ config['graph1d.autodistribution'] = 'On'
+ cls.ws2d_histo = CreateWorkspace(DataX=[10, 20, 30, 10, 20, 30],
+ DataY=[2, 3, 4, 5],
+ DataE=[1, 2, 3, 4],
+ NSpec=2,
+ Distribution=True,
+ YUnitLabel="Counts per $\\AA$",
+ UnitX='Wavelength',
+ VerticalAxisUnit='DeltaE',
+ VerticalAxisValues=[4, 6, 8],
+ OutputWorkspace='ws2d_histo')
+ cls.ws2d_histo_non_dist = CreateWorkspace(DataX=[10, 20, 30, 10, 20, 30],
+ DataY=[2, 3, 4, 5],
+ DataE=[1, 2, 3, 4],
+ NSpec=2,
+ Distribution=False,
+ YUnitLabel='Counts',
+ UnitX='Wavelength',
+ OutputWorkspace='ws2d_histo_non_dist')
+ cls.ws2d_histo_rag = CreateWorkspace(DataX=[1, 2, 3, 4, 5, 2, 4, 6, 8, 10],
+ DataY=[2] * 8,
+ NSpec=2,
+ VerticalAxisUnit='DeltaE',
+ VerticalAxisValues=[5, 7, 9],
+ OutputWorkspace='ws2d_histo_rag')
+ cls.ws_MD_2d = CreateMDHistoWorkspace(Dimensionality=3,
+ Extents='-3,3,-10,10,-1,1',
+ SignalInput=range(25),
+ ErrorInput=range(25),
+ NumberOfEvents=10 * np.ones(25),
+ NumberOfBins='5,5,1',
+ Names='Dim1,Dim2,Dim3',
+ Units='MomentumTransfer,EnergyTransfer,Angstrom',
+ OutputWorkspace='ws_MD_2d')
+ cls.ws_MD_1d = CreateMDHistoWorkspace(Dimensionality=3,
+ Extents='-3,3,-10,10,-1,1',
+ SignalInput=range(5),
+ ErrorInput=range(5),
+ NumberOfEvents=10 * np.ones(5),
+ NumberOfBins='1,5,1',
+ Names='Dim1,Dim2,Dim3',
+ Units='MomentumTransfer,EnergyTransfer,Angstrom',
+ OutputWorkspace='ws_MD_1d')
+ cls.ws2d_point_uneven = CreateWorkspace(DataX=[10, 20, 30],
+ DataY=[1, 2, 3],
+ NSpec=1,
+ OutputWorkspace='ws2d_point_uneven')
+ wp = CreateWorkspace(DataX=[15, 25, 35, 45], DataY=[1, 2, 3, 4], NSpec=1)
+ ConjoinWorkspaces(cls.ws2d_point_uneven, wp, CheckOverlapping=False)
+ cls.ws2d_point_uneven = mantid.mtd['ws2d_point_uneven']
+ cls.ws2d_histo_uneven = CreateWorkspace(DataX=[10, 20, 30, 40],
+ DataY=[1, 2, 3],
+ NSpec=1,
+ OutputWorkspace='ws2d_histo_uneven')
+ AddTimeSeriesLog(cls.ws2d_histo, Name="my_log", Time="2010-01-01T00:00:00", Value=100)
+ AddTimeSeriesLog(cls.ws2d_histo, Name="my_log", Time="2010-01-01T00:30:00", Value=15)
+ AddTimeSeriesLog(cls.ws2d_histo, Name="my_log", Time="2010-01-01T00:50:00", Value=100.2)
+
+ @classmethod
+ def tearDownClass(cls):
+ config['graph1d.autodistribution'] = cls.g1da
+ DeleteWorkspace('ws2d_histo')
+ DeleteWorkspace('ws2d_histo_non_dist')
+ DeleteWorkspace('ws_MD_2d')
+ DeleteWorkspace('ws_MD_1d')
+ DeleteWorkspace('ws2d_point_uneven')
+
+ def test_1d_plots(self):
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws2d_histo, 'rs', specNum=1)
+ funcs.plot(ax, self.ws2d_histo, specNum=2, linewidth=6)
+ funcs.plot(ax, self.ws_MD_1d, 'bo')
+
+ def test_1d_log(self):
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws2d_histo, LogName='my_log')
+ ax1 = ax.twiny()
+ funcs.plot(ax1, self.ws2d_histo, LogName='my_log', FullTime=True)
+
+ def test_1d_errorbars(self):
+ fig, ax = plt.subplots()
+ funcs.errorbar(ax, self.ws2d_histo, 'rs', specNum=1)
+ funcs.errorbar(ax, self.ws2d_histo, specNum=2, linewidth=6)
+ funcs.errorbar(ax, self.ws_MD_1d, 'bo')
+
+ def test_1d_scatter(self):
+ fig, ax = plt.subplots()
+ funcs.scatter(ax, self.ws2d_histo, specNum=1)
+ funcs.scatter(ax, self.ws2d_histo, specNum=2)
+ funcs.scatter(ax, self.ws_MD_1d)
+
+ def test_2d_contours(self):
+ fig, ax = plt.subplots()
+ funcs.contour(ax, self.ws2d_histo_rag)
+ funcs.contourf(ax, self.ws2d_histo, vmin=0)
+ funcs.tricontour(ax, self.ws_MD_2d)
+ funcs.tricontourf(ax, self.ws_MD_2d)
+ self.assertRaises(ValueError, funcs.contour, ax, self.ws2d_point_uneven)
+
+ def test_2d_pcolors(self):
+ fig, ax = plt.subplots()
+ funcs.pcolor(ax, self.ws2d_histo_rag)
+ funcs.tripcolor(ax, self.ws2d_histo, vmin=0)
+ funcs.pcolormesh(ax, self.ws_MD_2d)
+ funcs.pcolorfast(ax, self.ws2d_point_uneven, vmin=-1)
+ funcs.imshow(ax, self.ws2d_histo)
+
+ def _do_update_colorplot_datalimits(self, color_func):
+ fig, ax = plt.subplots()
+ mesh = color_func(ax, self.ws2d_histo)
+ ax.set_xlim(0.01, 0.05)
+ ax.set_ylim(-0.05, 0.05)
+ funcs.update_colorplot_datalimits(ax, mesh)
+ self.assertAlmostEqual(10.0, ax.get_xlim()[0])
+ from distutils.version import LooseVersion
+
+ # different results with 1.5.3 and 2.1.1
+ if color_func.__name__ != 'imshow' and LooseVersion(matplotlib.__version__) < LooseVersion("2"):
+ self.assertAlmostEqual(100.0, ax.get_xlim()[1])
+ else:
+ self.assertAlmostEqual(30.0, ax.get_xlim()[1])
+ self.assertAlmostEqual(4.0, ax.get_ylim()[0])
+ self.assertAlmostEqual(8.0, ax.get_ylim()[1])
+
+ def test_update_colorplot_datalimits_for_pcolormesh(self):
+ self._do_update_colorplot_datalimits(funcs.pcolormesh)
+
+ def test_update_colorplot_datalimits_for_pcolor(self):
+ self._do_update_colorplot_datalimits(funcs.pcolor)
+
+ def test_update_colorplot_datalimits_for_imshow(self):
+ self._do_update_colorplot_datalimits(funcs.imshow)
+
+ def test_1d_plots_with_unplottable_type_raises_attributeerror(self):
+ table = CreateEmptyTableWorkspace()
+ _, ax = plt.subplots()
+ self.assertRaises(AttributeError, funcs.plot, ax, table, wkspIndex=0)
+ self.assertRaises(AttributeError, funcs.errorbar, ax, table, wkspIndex=0)
+
+ def test_2d_plots_with_unplottable_type_raises_attributeerror(self):
+ table = CreateEmptyTableWorkspace()
+ _, ax = plt.subplots()
+ self.assertRaises(AttributeError, funcs.pcolor, ax, table)
+ self.assertRaises(AttributeError, funcs.pcolormesh, ax, table)
+ self.assertRaises(AttributeError, funcs.pcolorfast, ax, table)
+
+ def test_1d_indices(self):
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws_MD_2d, indices=(slice(None), 0, 0))
+ funcs.plot(ax, self.ws_MD_2d, indices=(0, slice(None), 0))
+ funcs.plot(ax, self.ws_MD_2d, indices=(0, 0, slice(None)))
+ self.assertRaises(AssertionError, funcs.plot, ax, self.ws_MD_2d, indices=(0, slice(None), slice(None)))
+ self.assertRaises(AssertionError, funcs.plot, ax, self.ws_MD_2d)
+
+ def test_1d_slicepoint(self):
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws_MD_2d, slicepoint=(None, 0, 0))
+ funcs.plot(ax, self.ws_MD_2d, slicepoint=(0, None, 0))
+ funcs.plot(ax, self.ws_MD_2d, slicepoint=(0, 0, None))
+ self.assertRaises(AssertionError, funcs.plot, ax, self.ws_MD_2d, slicepoint=(0, None, None))
+ self.assertRaises(AssertionError, funcs.plot, ax, self.ws_MD_2d)
+
+ def test_1d_x_axes_label_spectrum_plot(self):
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws2d_histo_non_dist, 'rs', specNum=1, axis=MantidAxType.SPECTRUM)
+ self.assertEqual(ax.get_xlabel(), "Wavelength ($\\AA$)")
+
+ def test_1d_x_axes_label_bin_plot(self):
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws2d_histo_non_dist, 'rs', specNum=1, axis=MantidAxType.BIN)
+ self.assertEqual(ax.get_xlabel(), "Spectrum")
+
+ def test_1d_y_axes_label_auto_distribution_on(self):
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws2d_histo_non_dist, 'rs', specNum=1)
+ self.assertEqual(ax.get_ylabel(), "Counts ($\\AA$)$^{-1}$")
+
+ def test_1d_y_axes_label_distribution_workspace_auto_distribution_on(self):
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws2d_histo, 'rs', specNum=1)
+ self.assertEqual(ax.get_ylabel(), "Counts ($\\AA$)$^{-1}$")
+
+ def test_1d_y_axes_label_auto_distribution_off(self):
+ try:
+ config['graph1d.autodistribution'] = 'Off'
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws2d_histo_non_dist, 'rs', specNum=1)
+ self.assertEqual(ax.get_ylabel(), "Counts")
+ finally:
+ config['graph1d.autodistribution'] = 'On'
+
+ def test_1d_y_axes_label_distribution_workspace_auto_distribution_off(self):
+ try:
+ config['graph1d.autodistribution'] = 'Off'
+ fig, ax = plt.subplots()
+ funcs.plot(ax, self.ws2d_histo, 'rs', specNum=1)
+ self.assertEqual(ax.get_ylabel(), "Counts ($\\AA$)$^{-1}$")
+ finally:
+ config['graph1d.autodistribution'] = 'On'
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/Framework/PythonInterface/test/python/mantid/plots/compatabilityTest.py b/Framework/PythonInterface/test/python/mantid/plots/compatabilityTest.py
new file mode 100644
index 0000000000000000000000000000000000000000..7228a4ad09e30d6939b6b50b40aea9d51b6476f2
--- /dev/null
+++ b/Framework/PythonInterface/test/python/mantid/plots/compatabilityTest.py
@@ -0,0 +1,167 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+# This file is part of the mantid workbench.
+#
+#
+from __future__ import absolute_import
+
+# std imports
+import unittest
+
+# third party imports
+import matplotlib
+
+matplotlib.use('AGG') # noqa
+
+
+# local imports
+from mantid.py3compat.mock import patch
+from mantid.plots._compatability import plotSpectrum, plotBin
+from mantid.plots.utility import MantidAxType
+
+class compatabilityTest(unittest.TestCase):
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotSpectrum_calls_plot_with_a_string(self, plot_mock):
+ ws_name = 'test_plotSpectrum_calls_plot_with_a_string-1'
+ wksp_indices = 0
+ plotSpectrum(ws_name,wksp_indices)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=[wksp_indices],errors=False, spectrum_nums=None, waterfall=None,
+ fig=None, overplot=False, plot_kwargs={})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotSpectrum_calls_plot_with_a_list(self, plot_mock):
+ ws_name = ['test_plotSpectrum_calls_plot_with_a_list-1','test_plotSpectrum_calls_plot_with_a_list']
+ wksp_indices = list(range(10))
+ plotSpectrum(ws_name,wksp_indices)
+ plot_mock.assert_called_once_with(ws_name,wksp_indices=wksp_indices,errors=False, spectrum_nums=None, waterfall=None,
+ fig=None, overplot=False, plot_kwargs={})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotSpectrum_calls_plot_with_errors(self, plot_mock):
+ ws_name = 'test_plotSpectrum_calls_plot_with_a_string-1'
+ wksp_indices = 0
+ plotSpectrum(ws_name,wksp_indices,error_bars=True)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=[wksp_indices],errors=True, spectrum_nums=None, waterfall=None,
+ fig=None, overplot=False, plot_kwargs={})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotSpectrum_calls_plot_with_spectrum_numbers(self, plot_mock):
+ ws_name = 'test_plotSpectrum_calls_plot_with_spectrum_numbers-1'
+ wksp_indices = 0
+ plotSpectrum(ws_name,spectrum_nums=wksp_indices)
+ plot_mock.assert_called_once_with([ws_name],spectrum_nums=[wksp_indices],errors=False, wksp_indices=None, waterfall=None,
+ fig=None, overplot=False, plot_kwargs={})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotSpectrum_calls_plot_with_no_line(self, plot_mock):
+ ws_name = 'test_plotSpectrum_calls_plot_with_no_line-1'
+ wksp_indices = list(range(10))
+ plotSpectrum(ws_name,wksp_indices,type=1)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=wksp_indices,errors=False, spectrum_nums=None, waterfall=None,
+ fig=None, overplot=False, plot_kwargs={'linestyle': 'None', 'marker': '.'})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotSpectrum_calls_plot_with_waterfall(self, plot_mock):
+ ws_name = 'test_plotSpectrum_calls_plot_with_waterfall-1'
+ wksp_indices = list(range(10))
+ plotSpectrum(ws_name,wksp_indices,waterfall=True)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=wksp_indices,errors=False, spectrum_nums=None, waterfall=True,
+ fig=None, overplot=False, plot_kwargs={})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotSpectrum_calls_plot_with_clear_window(self, plot_mock):
+ ws_name = 'test_plotSpectrum_calls_plot_with_clear_window-1'
+ wksp_indices = list(range(10))
+ fake_window = "this is a string representing a fake plotting window"
+ plotSpectrum(ws_name,wksp_indices,window=fake_window,clearWindow=True)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=wksp_indices,errors=False, spectrum_nums=None, waterfall=None,
+ fig=fake_window, overplot=False, plot_kwargs={})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotSpectrum_calls_plot_with_overplot(self, plot_mock):
+ ws_name = 'test_plotSpectrum_calls_plot_with_overplot-1'
+ wksp_indices = list(range(10))
+ fake_window = "this is a string representing a fake plotting window"
+ plotSpectrum(ws_name,wksp_indices,window=fake_window)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=wksp_indices,errors=False, spectrum_nums=None, waterfall=None,
+ fig=fake_window, overplot=True, plot_kwargs={})
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotBin_calls_plot_with_a_string(self, plot_mock):
+ ws_name = 'test_plotBin_calls_plot_with_a_string-1'
+ wksp_indices = 0
+ plotBin(ws_name,wksp_indices)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=[wksp_indices],errors=False, waterfall=None,
+ fig=None, overplot=False, plot_kwargs={'axis': MantidAxType.BIN})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotBin_calls_plot_with_a_list(self, plot_mock):
+ ws_name = ['test_plotBin_calls_plot_with_a_list-1','test_plotBin_calls_plot_with_a_list']
+ wksp_indices = list(range(10))
+ plotBin(ws_name,wksp_indices)
+ plot_mock.assert_called_once_with(ws_name,wksp_indices=wksp_indices,errors=False, waterfall=None,
+ fig=None, overplot=False, plot_kwargs={'axis': MantidAxType.BIN})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotBin_calls_plot_with_errors(self, plot_mock):
+ ws_name = 'test_plotBin_calls_plot_with_a_string-1'
+ wksp_indices = 0
+ plotBin(ws_name,wksp_indices,error_bars=True)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=[wksp_indices],errors=True, waterfall=None,
+ fig=None, overplot=False, plot_kwargs={'axis': MantidAxType.BIN})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotBin_calls_plot_with_no_line(self, plot_mock):
+ ws_name = 'test_plotBin_calls_plot_with_no_line-1'
+ wksp_indices = list(range(10))
+ plotBin(ws_name,wksp_indices,type=1)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=wksp_indices,errors=False, waterfall=None,
+ fig=None, overplot=False,
+ plot_kwargs={'axis': MantidAxType.BIN, 'linestyle': 'None', 'marker': '.'})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotBin_calls_plot_with_waterfall(self, plot_mock):
+ ws_name = 'test_plotBin_calls_plot_with_waterfall-1'
+ wksp_indices = list(range(10))
+ plotBin(ws_name,wksp_indices,waterfall=True)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=wksp_indices,errors=False, waterfall=True,
+ fig=None, overplot=False, plot_kwargs={'axis': MantidAxType.BIN})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotBin_calls_plot_with_clear_window(self, plot_mock):
+ ws_name = 'test_plotBin_calls_plot_with_clear_window-1'
+ wksp_indices = list(range(10))
+ fake_window = "this is a string representing a fake plotting window"
+ plotBin(ws_name,wksp_indices,window=fake_window,clearWindow=True)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=wksp_indices,errors=False, waterfall=None,
+ fig=fake_window, overplot=False, plot_kwargs={'axis': MantidAxType.BIN})
+
+
+ @patch('mantid.plots._compatability.plot')
+ def test_plotBin_calls_plot_with_overplot(self, plot_mock):
+ ws_name = 'test_plotBin_calls_plot_with_overplot-1'
+ wksp_indices = list(range(10))
+ fake_window = "this is a string representing a fake plotting window"
+ plotBin(ws_name,wksp_indices,window=fake_window)
+ plot_mock.assert_called_once_with([ws_name],wksp_indices=wksp_indices,errors=False, waterfall=None,
+ fig=fake_window, overplot=True, plot_kwargs={'axis': MantidAxType.BIN})
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/Framework/PythonInterface/test/python/mantid/plots/helperfunctionsTest.py b/Framework/PythonInterface/test/python/mantid/plots/datafunctionsTest.py
similarity index 99%
rename from Framework/PythonInterface/test/python/mantid/plots/helperfunctionsTest.py
rename to Framework/PythonInterface/test/python/mantid/plots/datafunctionsTest.py
index c233ed3b9d4f2005df5727bb3a1ee9d2e67e114a..5a1645224e69f2808c30e0964d6ed334cb94fe96 100644
--- a/Framework/PythonInterface/test/python/mantid/plots/helperfunctionsTest.py
+++ b/Framework/PythonInterface/test/python/mantid/plots/datafunctionsTest.py
@@ -16,7 +16,7 @@ from matplotlib.pyplot import figure
import numpy as np
import mantid.api
-import mantid.plots.helperfunctions as funcs
+import mantid.plots.datafunctions as funcs
from mantid.py3compat.mock import Mock
from mantid.kernel import config
from mantid.plots.utility import MantidAxType
@@ -74,7 +74,7 @@ def add_md_workspace_with_data(dimensions=2):
return function_wrapper
-class HelperFunctionsTest(unittest.TestCase):
+class DataFunctionsTest(unittest.TestCase):
@classmethod
def setUpClass(cls):
@@ -805,21 +805,21 @@ class HelperFunctionsTest(unittest.TestCase):
return artist
def test_errorbars_hidden_returns_true_for_non_errorbar_container_object(self):
- self.assertTrue(mantid.plots.helperfunctions.errorbars_hidden(Mock()))
+ self.assertTrue(mantid.plots.datafunctions.errorbars_hidden(Mock()))
def test_errorbars_hidden_returns_correctly_on_errorbar_container(self):
container = self._create_artist(errors=True)
- self.assertFalse(mantid.plots.helperfunctions.errorbars_hidden(container))
+ self.assertFalse(mantid.plots.datafunctions.errorbars_hidden(container))
[caps.set_visible(False) for caps in container[1] if container[1]]
[bars.set_visible(False) for bars in container[2]]
- self.assertTrue(mantid.plots.helperfunctions.errorbars_hidden(container))
+ self.assertTrue(mantid.plots.datafunctions.errorbars_hidden(container))
def test_errorbars_hidden_returns_true_on_container_with_invisible_connecting_line(self):
container = self._create_artist(errors=True)
container[0].set_visible(False)
[caps.set_visible(False) for caps in container[1] if container[1]]
[bars.set_visible(False) for bars in container[2]]
- self.assertTrue(mantid.plots.helperfunctions.errorbars_hidden(container))
+ self.assertTrue(mantid.plots.datafunctions.errorbars_hidden(container))
if __name__ == '__main__':
diff --git a/Framework/PythonInterface/test/python/mantid/plots/plotfunctionsTest.py b/Framework/PythonInterface/test/python/mantid/plots/plotfunctionsTest.py
index a64820f6887df7b7b33974748f84e142f63f4673..8ae15feb49cf931ac2f6391e383d598586c612bc 100644
--- a/Framework/PythonInterface/test/python/mantid/plots/plotfunctionsTest.py
+++ b/Framework/PythonInterface/test/python/mantid/plots/plotfunctionsTest.py
@@ -4,229 +4,210 @@
# NScD Oak Ridge National Laboratory, European Spallation Source
# & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
-from __future__ import (absolute_import, division, print_function)
+# This file is part of the mantid workbench.
+#
+#
+from __future__ import absolute_import
-import matplotlib
+# std imports
import unittest
-matplotlib.use('AGG') # noqa
+# third party imports
+import matplotlib
+matplotlib.use('AGG') # noqa
import matplotlib.pyplot as plt
import numpy as np
-import mantid.api
-import mantid.plots.plotfunctions as funcs
-from mantid.plots.utility import MantidAxType
+# local imports
+# register mantid projection
+import mantid.plots # noqa
+from mantid.api import AnalysisDataService, WorkspaceFactory
from mantid.kernel import config
-from mantid.simpleapi import (CreateWorkspace, CreateEmptyTableWorkspace, DeleteWorkspace,
- CreateMDHistoWorkspace, ConjoinWorkspaces, AddTimeSeriesLog)
-
-
-class PlotFunctionsTest(unittest.TestCase):
-
- @classmethod
- def setUpClass(cls):
- cls.g1da = config['graph1d.autodistribution']
- config['graph1d.autodistribution'] = 'On'
- cls.ws2d_histo = CreateWorkspace(DataX=[10, 20, 30, 10, 20, 30],
- DataY=[2, 3, 4, 5],
- DataE=[1, 2, 3, 4],
- NSpec=2,
- Distribution=True,
- YUnitLabel="Counts per $\\AA$",
- UnitX='Wavelength',
- VerticalAxisUnit='DeltaE',
- VerticalAxisValues=[4, 6, 8],
- OutputWorkspace='ws2d_histo')
- cls.ws2d_histo_non_dist = CreateWorkspace(DataX=[10, 20, 30, 10, 20, 30],
- DataY=[2, 3, 4, 5],
- DataE=[1, 2, 3, 4],
- NSpec=2,
- Distribution=False,
- YUnitLabel='Counts',
- UnitX='Wavelength',
- OutputWorkspace='ws2d_histo_non_dist')
- cls.ws2d_histo_rag = CreateWorkspace(DataX=[1, 2, 3, 4, 5, 2, 4, 6, 8, 10],
- DataY=[2] * 8,
- NSpec=2,
- VerticalAxisUnit='DeltaE',
- VerticalAxisValues=[5, 7, 9],
- OutputWorkspace='ws2d_histo_rag')
- cls.ws_MD_2d = CreateMDHistoWorkspace(Dimensionality=3,
- Extents='-3,3,-10,10,-1,1',
- SignalInput=range(25),
- ErrorInput=range(25),
- NumberOfEvents=10 * np.ones(25),
- NumberOfBins='5,5,1',
- Names='Dim1,Dim2,Dim3',
- Units='MomentumTransfer,EnergyTransfer,Angstrom',
- OutputWorkspace='ws_MD_2d')
- cls.ws_MD_1d = CreateMDHistoWorkspace(Dimensionality=3,
- Extents='-3,3,-10,10,-1,1',
- SignalInput=range(5),
- ErrorInput=range(5),
- NumberOfEvents=10 * np.ones(5),
- NumberOfBins='1,5,1',
- Names='Dim1,Dim2,Dim3',
- Units='MomentumTransfer,EnergyTransfer,Angstrom',
- OutputWorkspace='ws_MD_1d')
- cls.ws2d_point_uneven = CreateWorkspace(DataX=[10, 20, 30],
- DataY=[1, 2, 3],
- NSpec=1,
- OutputWorkspace='ws2d_point_uneven')
- wp = CreateWorkspace(DataX=[15, 25, 35, 45], DataY=[1, 2, 3, 4], NSpec=1)
- ConjoinWorkspaces(cls.ws2d_point_uneven, wp, CheckOverlapping=False)
- cls.ws2d_point_uneven = mantid.mtd['ws2d_point_uneven']
- cls.ws2d_histo_uneven = CreateWorkspace(DataX=[10, 20, 30, 40],
- DataY=[1, 2, 3],
- NSpec=1,
- OutputWorkspace='ws2d_histo_uneven')
- AddTimeSeriesLog(cls.ws2d_histo, Name="my_log", Time="2010-01-01T00:00:00", Value=100)
- AddTimeSeriesLog(cls.ws2d_histo, Name="my_log", Time="2010-01-01T00:30:00", Value=15)
- AddTimeSeriesLog(cls.ws2d_histo, Name="my_log", Time="2010-01-01T00:50:00", Value=100.2)
-
- @classmethod
- def tearDownClass(cls):
- config['graph1d.autodistribution'] = cls.g1da
- DeleteWorkspace('ws2d_histo')
- DeleteWorkspace('ws2d_histo_non_dist')
- DeleteWorkspace('ws_MD_2d')
- DeleteWorkspace('ws_MD_1d')
- DeleteWorkspace('ws2d_point_uneven')
-
- def test_1d_plots(self):
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws2d_histo, 'rs', specNum=1)
- funcs.plot(ax, self.ws2d_histo, specNum=2, linewidth=6)
- funcs.plot(ax, self.ws_MD_1d, 'bo')
-
- def test_1d_log(self):
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws2d_histo, LogName='my_log')
- ax1 = ax.twiny()
- funcs.plot(ax1, self.ws2d_histo, LogName='my_log', FullTime=True)
-
- def test_1d_errorbars(self):
- fig, ax = plt.subplots()
- funcs.errorbar(ax, self.ws2d_histo, 'rs', specNum=1)
- funcs.errorbar(ax, self.ws2d_histo, specNum=2, linewidth=6)
- funcs.errorbar(ax, self.ws_MD_1d, 'bo')
-
- def test_1d_scatter(self):
- fig, ax = plt.subplots()
- funcs.scatter(ax, self.ws2d_histo, specNum=1)
- funcs.scatter(ax, self.ws2d_histo, specNum=2)
- funcs.scatter(ax, self.ws_MD_1d)
-
- def test_2d_contours(self):
- fig, ax = plt.subplots()
- funcs.contour(ax, self.ws2d_histo_rag)
- funcs.contourf(ax, self.ws2d_histo, vmin=0)
- funcs.tricontour(ax, self.ws_MD_2d)
- funcs.tricontourf(ax, self.ws_MD_2d)
- self.assertRaises(ValueError, funcs.contour, ax, self.ws2d_point_uneven)
-
- def test_2d_pcolors(self):
- fig, ax = plt.subplots()
- funcs.pcolor(ax, self.ws2d_histo_rag)
- funcs.tripcolor(ax, self.ws2d_histo, vmin=0)
- funcs.pcolormesh(ax, self.ws_MD_2d)
- funcs.pcolorfast(ax, self.ws2d_point_uneven, vmin=-1)
- funcs.imshow(ax, self.ws2d_histo)
-
- def _do_update_colorplot_datalimits(self, color_func):
- fig, ax = plt.subplots()
- mesh = color_func(ax, self.ws2d_histo)
- ax.set_xlim(0.01, 0.05)
- ax.set_ylim(-0.05, 0.05)
- funcs.update_colorplot_datalimits(ax, mesh)
- self.assertAlmostEqual(10.0, ax.get_xlim()[0])
- from distutils.version import LooseVersion
-
- # different results with 1.5.3 and 2.1.1
- if color_func.__name__ != 'imshow' and LooseVersion(matplotlib.__version__) < LooseVersion("2"):
- self.assertAlmostEqual(100.0, ax.get_xlim()[1])
+from mantid.plots import MantidAxes
+from mantid.py3compat import mock
+from mantid.plots.plotfunctions import (figure_title,
+ manage_workspace_names, plot)
+
+
+# Avoid importing the whole of mantid for a single mock of the workspace class
+class FakeWorkspace(object):
+ def __init__(self, name):
+ self._name = name
+
+ def name(self):
+ return self._name
+
+
+@manage_workspace_names
+def workspace_names_dummy_func(workspaces):
+ return workspaces
+
+
+class FunctionsTest(unittest.TestCase):
+
+ _test_ws = None
+
+ def setUp(self):
+ if self._test_ws is None:
+ self.__class__._test_ws = WorkspaceFactory.Instance().create(
+ "Workspace2D", NVectors=2, YLength=5, XLength=5)
+
+ def tearDown(self):
+ AnalysisDataService.Instance().clear()
+ plt.close('all')
+
+ def test_figure_title_with_single_string(self):
+ self.assertEqual("test-1", figure_title("test", 1))
+
+ def test_figure_title_with_list_of_strings(self):
+ self.assertEqual("first-10", figure_title(["first", "second"], 10))
+
+ def test_figure_title_with_single_workspace(self):
+ self.assertEqual("fake-5", figure_title(FakeWorkspace("fake"), 5))
+
+ def test_figure_title_with_workspace_list(self):
+ self.assertEqual("fake-10", figure_title((FakeWorkspace("fake"),
+ FakeWorkspace("nextfake")), 10))
+
+ def test_figure_title_with_empty_list_raises_assertion(self):
+ with self.assertRaises(AssertionError):
+ figure_title([], 5)
+
+ def test_that_plot_can_accept_workspace_names(self):
+ ws_name1 = "some_workspace"
+ AnalysisDataService.Instance().addOrReplace(ws_name1, self._test_ws)
+
+ try:
+ result_workspaces = workspace_names_dummy_func([ws_name1])
+ except ValueError:
+ self.fail("Passing workspace names should not raise a value error.")
else:
- self.assertAlmostEqual(30.0, ax.get_xlim()[1])
- self.assertAlmostEqual(4.0, ax.get_ylim()[0])
- self.assertAlmostEqual(8.0, ax.get_ylim()[1])
-
- def test_update_colorplot_datalimits_for_pcolormesh(self):
- self._do_update_colorplot_datalimits(funcs.pcolormesh)
-
- def test_update_colorplot_datalimits_for_pcolor(self):
- self._do_update_colorplot_datalimits(funcs.pcolor)
-
- def test_update_colorplot_datalimits_for_imshow(self):
- self._do_update_colorplot_datalimits(funcs.imshow)
-
- def test_1d_plots_with_unplottable_type_raises_attributeerror(self):
- table = CreateEmptyTableWorkspace()
- _, ax = plt.subplots()
- self.assertRaises(AttributeError, funcs.plot, ax, table, wkspIndex=0)
- self.assertRaises(AttributeError, funcs.errorbar, ax, table, wkspIndex=0)
-
- def test_2d_plots_with_unplottable_type_raises_attributeerror(self):
- table = CreateEmptyTableWorkspace()
- _, ax = plt.subplots()
- self.assertRaises(AttributeError, funcs.pcolor, ax, table)
- self.assertRaises(AttributeError, funcs.pcolormesh, ax, table)
- self.assertRaises(AttributeError, funcs.pcolorfast, ax, table)
-
- def test_1d_indices(self):
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws_MD_2d, indices=(slice(None), 0, 0))
- funcs.plot(ax, self.ws_MD_2d, indices=(0, slice(None), 0))
- funcs.plot(ax, self.ws_MD_2d, indices=(0, 0, slice(None)))
- self.assertRaises(AssertionError, funcs.plot, ax, self.ws_MD_2d, indices=(0, slice(None), slice(None)))
- self.assertRaises(AssertionError, funcs.plot, ax, self.ws_MD_2d)
-
- def test_1d_slicepoint(self):
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws_MD_2d, slicepoint=(None, 0, 0))
- funcs.plot(ax, self.ws_MD_2d, slicepoint=(0, None, 0))
- funcs.plot(ax, self.ws_MD_2d, slicepoint=(0, 0, None))
- self.assertRaises(AssertionError, funcs.plot, ax, self.ws_MD_2d, slicepoint=(0, None, None))
- self.assertRaises(AssertionError, funcs.plot, ax, self.ws_MD_2d)
-
- def test_1d_x_axes_label_spectrum_plot(self):
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws2d_histo_non_dist, 'rs', specNum=1, axis=MantidAxType.SPECTRUM)
- self.assertEqual(ax.get_xlabel(), "Wavelength ($\\AA$)")
-
- def test_1d_x_axes_label_bin_plot(self):
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws2d_histo_non_dist, 'rs', specNum=1, axis=MantidAxType.BIN)
- self.assertEqual(ax.get_xlabel(), "Spectrum")
-
- def test_1d_y_axes_label_auto_distribution_on(self):
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws2d_histo_non_dist, 'rs', specNum=1)
- self.assertEqual(ax.get_ylabel(), "Counts ($\\AA$)$^{-1}$")
-
- def test_1d_y_axes_label_distribution_workspace_auto_distribution_on(self):
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws2d_histo, 'rs', specNum=1)
- self.assertEqual(ax.get_ylabel(), "Counts ($\\AA$)$^{-1}$")
-
- def test_1d_y_axes_label_auto_distribution_off(self):
+ # The list of workspace names we pass in should have been converted
+ # to a list of workspaces
+ self.assertNotEqual(result_workspaces, [ws_name1])
+
+ def test_workspace_can_be_plotted_on_top_of_scripted_plots(self):
+ fig = plt.figure()
+ plt.plot([0, 1], [0, 1])
+ ws = self._test_ws
+ plot([ws], wksp_indices=[1], fig=fig, overplot=True)
+ ax = plt.gca()
+ self.assertEqual(len(ax.lines), 2)
+
+ def test_title_preserved_when_workspace_plotted_on_scripted_plot(self):
+ fig = plt.figure()
+ plt.plot([0, 1], [0, 1])
+ plt.title("My Title")
+ ws = self._test_ws
+ plot([ws], wksp_indices=[1], fig=fig, overplot=True)
+ ax = plt.gca()
+ self.assertEqual("My Title", ax.get_title())
+
+ def test_different_line_colors_when_plotting_over_scripted_fig(self):
+ fig = plt.figure()
+ plt.plot([0, 1], [0, 1])
+ ws = self._test_ws
+ plot([ws], wksp_indices=[1], fig=fig, overplot=True)
+ ax = plt.gca()
+ line_colors = [line.get_color() for line in ax.get_lines()]
+ self.assertNotEqual(line_colors[0], line_colors[1])
+
+ def test_workspace_tracked_when_plotting_over_scripted_fig(self):
+ fig = plt.figure()
+ plt.plot([0, 1], [0, 1])
+ ws = self._test_ws
+ plot([ws], wksp_indices=[1], fig=fig, overplot=True)
+ ax = plt.gca()
+ self.assertIn(ws.name(), ax.tracked_workspaces)
+
+ def test_from_mpl_axes_success_with_default_args(self):
+ plt.figure()
+ plt.plot([0, 1], [0, 1])
+ plt.plot([0, 2], [0, 2])
+ ax = plt.gca()
+ mantid_ax = MantidAxes.from_mpl_axes(ax)
+ self.assertEqual(len(mantid_ax.lines), 2)
+ self.assertIsInstance(mantid_ax, MantidAxes)
+
+ def test_that_plot_spectrum_has_same_y_label_with_and_without_errorbars(self):
+ auto_dist = config['graph1d.autodistribution']
try:
config['graph1d.autodistribution'] = 'Off'
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws2d_histo_non_dist, 'rs', specNum=1)
- self.assertEqual(ax.get_ylabel(), "Counts")
+ self._compare_errorbar_labels_and_title()
finally:
- config['graph1d.autodistribution'] = 'On'
+ config['graph1d.autodistribution'] = auto_dist
- def test_1d_y_axes_label_distribution_workspace_auto_distribution_off(self):
+ def test_that_plot_spectrum_has_same_y_label_with_and_without_errorbars_normalize_by_bin_width(self):
+ auto_dist = config['graph1d.autodistribution']
try:
- config['graph1d.autodistribution'] = 'Off'
- fig, ax = plt.subplots()
- funcs.plot(ax, self.ws2d_histo, 'rs', specNum=1)
- self.assertEqual(ax.get_ylabel(), "Counts ($\\AA$)$^{-1}$")
- finally:
config['graph1d.autodistribution'] = 'On'
-
+ self._compare_errorbar_labels_and_title()
+ finally:
+ config['graph1d.autodistribution'] = auto_dist
+
+ def test_setting_waterfall_to_true_makes_waterfall_plot(self):
+ fig = plt.figure()
+ ws = self._test_ws
+ plot([ws], wksp_indices=[0,1], fig=fig, waterfall=True)
+ ax = plt.gca()
+
+ self.assertTrue(ax.is_waterfall())
+
+ def test_cannot_make_waterfall_plot_with_one_line(self):
+ fig = plt.figure()
+ ws = self._test_ws
+ plot([ws], wksp_indices=[1], fig=fig, waterfall=True)
+ ax = plt.gca()
+
+ self.assertFalse(ax.is_waterfall())
+
+ def test_overplotting_onto_waterfall_plot_maintains_waterfall(self):
+ fig = plt.figure()
+ ws = self._test_ws
+ plot([ws], wksp_indices=[0,1], fig=fig, waterfall=True)
+ # Overplot one of the same lines.
+ plot([ws], wksp_indices=[0], fig=fig, overplot=True)
+ ax = plt.gca()
+
+ # Check that the lines which would be the same in a non-waterfall plot are different.
+ self.assertNotEqual(ax.get_lines()[0].get_xdata()[0], ax.get_lines()[2].get_xdata()[0])
+ self.assertNotEqual(ax.get_lines()[0].get_ydata()[0], ax.get_lines()[2].get_ydata()[0])
+
+ def test_overplotting_onto_waterfall_plot_with_filled_areas_adds_another_filled_area(self):
+ fig = plt.figure()
+ ws = self._test_ws
+ plot([ws], wksp_indices=[0, 1], fig=fig, waterfall=True)
+ ax = plt.gca()
+ ax.set_waterfall_fill(True)
+ plot([ws], wksp_indices=[0], fig=fig, overplot=True)
+
+ fills = [collection for collection in ax.collections
+ if isinstance(collection, matplotlib.collections.PolyCollection)]
+
+ self.assertEqual(len(fills), 3)
+
+ # ------------- Failure tests -------------
+ def test_that_manage_workspace_names_raises_on_mix_of_workspaces_and_names(self):
+ ws = ["some_workspace", self._test_ws]
+ AnalysisDataService.Instance().addOrReplace("some_workspace", self._test_ws)
+ self.assertRaises(TypeError, workspace_names_dummy_func(ws))
+
+ # ------------- Private -------------------
+ def _compare_errorbar_labels_and_title(self):
+ ws = self._test_ws
+ ws.setYUnitLabel("MyLabel")
+ ws.getAxis(0).setUnit("TOF")
+ for distribution_ws in [True, False]:
+ ws.setDistribution(distribution_ws)
+ ax = plot([ws], wksp_indices=[1]).get_axes()[0]
+ err_ax = plot([ws], wksp_indices=[1], errors=True).get_axes()[0]
+ # Compare y-labels
+ self.assertEqual(ax.get_ylabel(), err_ax.get_ylabel())
+ # Compare x-labels
+ self.assertEqual(ax.get_xlabel(), err_ax.get_xlabel())
+ # Compare title
+ self.assertEqual(ax.get_title(), err_ax.get_title())
if __name__ == '__main__':
unittest.main()
diff --git a/Framework/PythonInterface/test/python/mantid/plots/plots__init__Test.py b/Framework/PythonInterface/test/python/mantid/plots/plots__init__Test.py
index a346436dfb497be177cef451162ec545c9974721..5a157f8aa46397ec60a08eafecd3b51b43de2eb4 100644
--- a/Framework/PythonInterface/test/python/mantid/plots/plots__init__Test.py
+++ b/Framework/PythonInterface/test/python/mantid/plots/plots__init__Test.py
@@ -16,10 +16,10 @@ import numpy as np
import unittest
from mantid.kernel import config
-from mantid.plots import helperfunctions
+from mantid.plots import datafunctions
from mantid.plots.legend import convert_color_to_hex
-from mantid.plots.plotfunctions import get_colorplot_extents
from mantid.plots.utility import MantidAxType
+from mantid.plots.axesfunctions import get_colorplot_extents
from mantid.py3compat.mock import Mock, patch
from mantid.simpleapi import (CreateWorkspace, CreateSampleWorkspace, DeleteWorkspace,
RemoveSpectra, AnalysisDataService as ADS)
@@ -574,7 +574,7 @@ class Plots__init__Test(unittest.TestCase):
# Add filled areas.
ax.set_waterfall_fill(True)
- fills = helperfunctions.get_waterfall_fills(ax)
+ fills = datafunctions.get_waterfall_fills(ax)
self.assertEqual(len(fills), 2)
def test_remove_fill_removes_fills_for_waterfall_plots(self):
@@ -620,8 +620,8 @@ class Plots__init__Test(unittest.TestCase):
# Plot another line and make it join the waterfall.
ax.plot([0, 1], [0,1], color='#00fff0')
- helperfunctions.convert_single_line_to_waterfall(ax, 2)
- helperfunctions.waterfall_update_fill(ax)
+ datafunctions.convert_single_line_to_waterfall(ax, 2)
+ datafunctions.waterfall_update_fill(ax)
# Check that there are now three filled areas and the new line colour matches the new fill colour.
self.assertEqual(convert_color_to_hex(ax.collections[2].get_facecolor()[0]), ax.lines[2].get_color())
@@ -641,8 +641,8 @@ class Plots__init__Test(unittest.TestCase):
# Plot another line and make it join the waterfall.
ax.plot([0, 1], [0, 1])
- helperfunctions.convert_single_line_to_waterfall(ax, 2)
- helperfunctions.waterfall_update_fill(ax)
+ datafunctions.convert_single_line_to_waterfall(ax, 2)
+ datafunctions.waterfall_update_fill(ax)
# Check that there are now three filled areas and the new fill colour matches the others.
self.assertTrue((ax.collections[2].get_facecolor() == [1, 0, 0, 1]).all())
diff --git a/Framework/PythonInterface/test/python/plugins/algorithms/ReflectometryReductionOneLiveDataTest.py b/Framework/PythonInterface/test/python/plugins/algorithms/ReflectometryReductionOneLiveDataTest.py
index 9e3e1484a7220e3c220509e9b2493b4d0a129a99..b75e58d9a1df32322bcd5be3938243e19a874a8f 100644
--- a/Framework/PythonInterface/test/python/plugins/algorithms/ReflectometryReductionOneLiveDataTest.py
+++ b/Framework/PythonInterface/test/python/plugins/algorithms/ReflectometryReductionOneLiveDataTest.py
@@ -10,8 +10,7 @@ import unittest
from mantid.kernel import *
from mantid.api import *
-from mantid.simpleapi import (CreateWorkspace, ReflectometryReductionOneAuto,
- ReflectometryReductionOneLiveData)
+from mantid.simpleapi import (CreateWorkspace, ReflectometryReductionOneLiveData)
from testhelpers import (assertRaisesNothing, create_algorithm)
@@ -92,9 +91,9 @@ class ReflectometryReductionOneLiveDataTest(unittest.TestCase):
def test_all_child_properties_are_present(self):
# Get the properties for the child algorithm, apart from a list of known
# exclusions
- child_alg = create_algorithm('ReflectometryReductionOneAuto')
- excluded = ['ThetaIn', 'ThetaLogName', 'Diagnostics',
- 'FirstTransmissionRun', 'SecondTransmissionRun',
+ child_alg = create_algorithm('ReflectometryISISLoadAndProcess')
+ excluded = ['InputRunList', 'ThetaIn', 'ThetaLogName', 'OutputWorkspaceTransmission',
+ 'OutputWorkspaceFirstTransmission', 'OutputWorkspaceSecondTransmission',
'OutputWorkspaceBinned', 'OutputWorkspaceWavelength']
child_props = set([prop.name for prop in child_alg.getProperties() if prop.name not in excluded])
# Check the child properties exist in the parent algorithm
diff --git a/Framework/PythonInterface/test/python/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionFWSTest.py b/Framework/PythonInterface/test/python/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionFWSTest.py
index 99a6fa566f3310ee777ecc333031577db425bace..536ceb4fab39b181cfced14e43ce053416d0dd87 100644
--- a/Framework/PythonInterface/test/python/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionFWSTest.py
+++ b/Framework/PythonInterface/test/python/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionFWSTest.py
@@ -103,6 +103,26 @@ class IndirectILLReductionFWS(unittest.TestCase):
self.assertEquals(run.getLogData('MonitorLeftPeak').value, 2)
self.assertEquals(run.getLogData('MonitorRightPeak').value, 508)
+ def test_ifws_manual_peaks(self):
+
+ args = {'Run': '170304',
+ 'ManualInelasticPeakChannels': [3, 507],
+ 'OutputWorkspace': 'out'}
+
+ alg_test = run_algorithm('IndirectILLReductionFWS', **args)
+
+ self.assertTrue(alg_test.isExecuted(), "IndirectILLReductionFWS not executed")
+
+ self._check_workspace_group(mtd['out_red'], 1, 18, 1)
+
+ run = mtd['out_red'].getItem(0).getRun()
+
+ self.assertTrue(run.hasProperty('ManualInelasticLeftPeak'))
+ self.assertTrue(run.hasProperty('ManualInelasticRightPeak'))
+
+ self.assertEquals(run.getLogData('ManualInelasticLeftPeak').value, 3)
+ self.assertEquals(run.getLogData('ManualInelasticRightPeak').value, 507)
+
def _check_workspace_group(self, wsgroup, nentries, nspectra, nbins):
self.assertTrue(isinstance(wsgroup, WorkspaceGroup),
diff --git a/Framework/PythonInterface/test/python/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcessTest.py b/Framework/PythonInterface/test/python/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcessTest.py
index 157eb089b06ab3ae0a6ce7ecb74ef77a25745274..99c253390891c08f35a8008fea57f5ae034852bd 100644
--- a/Framework/PythonInterface/test/python/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcessTest.py
+++ b/Framework/PythonInterface/test/python/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcessTest.py
@@ -57,7 +57,7 @@ class ReflectometryISISLoadAndProcessTest(unittest.TestCase):
'IvsLam_38415_sliced_2400_3600', 'IvsQ_binned_38415_sliced_2400_3600', 'TOF_38415',
'TOF_38415_monitors', 'TOF_38415_sliced', 'TOF_38415_sliced_0_1200',
'TOF_38415_sliced_1200_2400', 'TOF_38415_sliced_2400_3600', 'TOF']
-
+
self._expected_real_time_sliced_outputs = [
'IvsQ_38415', 'IvsQ_38415_sliced_0_210', 'IvsQ_38415_sliced_210_420',
'IvsQ_38415_sliced_420_610', 'IvsQ_binned_38415', 'IvsQ_binned_38415_sliced_0_210',
@@ -458,9 +458,6 @@ class ReflectometryISISLoadAndProcessTest(unittest.TestCase):
GroupWorkspaces('TOF_13463, 12345', OutputWorkspace='mixed_unit_group')
args = self._default_options
args['InputRunList'] = '13460, mixed_unit_group'
- outputs = ['IvsQ_13460+13463', 'IvsQ_binned_13460+13463', 'TOF', 'TOF_13460+13463', 'TOF_13460',
- 'TOF_13463', '12345']
-
self._assert_run_algorithm_throws(args)
def test_no_TOF_input_workspace_groups_remain_unchanged(self):
@@ -470,8 +467,7 @@ class ReflectometryISISLoadAndProcessTest(unittest.TestCase):
args = self._default_options
args['InputRunList'] = '12345, 67890'
outputs = ['no_TOF_group', 'TOF_12345+67890', '12345', '67890']
-
- self._assert_run_algorithm_succeeds(args)
+ self._assert_run_algorithm_succeeds(args, outputs)
def test_group_TOF_workspaces_succeeds_with_only_TOF_workspaces(self):
self._create_workspace(13460, 'TOF_')
@@ -570,6 +566,12 @@ class ReflectometryISISLoadAndProcessTest(unittest.TestCase):
algNames = [alg.name() for alg in history]
self.assertEqual(algNames, expected)
+ def _check_history_algorithm_properties(self, ws, toplevel_idx, child_idx, property_values):
+ parent_hist = ws.getHistory().getAlgorithmHistory(toplevel_idx)
+ child_hist = parent_hist.getChildHistories()[child_idx]
+ for prop, val in property_values.items():
+ self.assertEqual(child_hist.getPropertyValue(prop), val)
+
def _assert_run_algorithm_succeeds(self, args, expected = None):
"""Run the algorithm with the given args and check it succeeds,
and that the additional workspaces produced match the expected list.
diff --git a/MantidPlot/mantidplotrc.py b/MantidPlot/mantidplotrc.py
index 5e3c038da146d6e061505a98b1d7751e5055c7e3..a0c455c11bcb615618653aad67b60ea94286c64c 100644
--- a/MantidPlot/mantidplotrc.py
+++ b/MantidPlot/mantidplotrc.py
@@ -28,6 +28,10 @@ if __name__ == '__main__':
# Import MantidPlot python commands
import mantidplot
from mantidplot import *
+ # cache plotSpectrum and plotBin as the will be overwritten when we import simpleapi
+ _plotSpectrum_saved = plotSpectrum
+ _plotBin_saved = plotBin
+
try:
# The MantidPlot namespace is not ready for the python3-style range function
# so we ensure we revert back to the current built-in version
@@ -44,6 +48,13 @@ if __name__ == '__main__':
from mantid.api import *
from mantid.simpleapi import *
+ #restore the mantidplot plotSpectrum and plotBin
+ #they have just been overwritten by the workbench variants
+ plotSpectrum = _plotSpectrum_saved
+ plotBin = _plotBin_saved
+ del _plotSpectrum_saved
+ del _plotBin_saved
+
# Common imports (here for backwards compatibility)
import os
import sys
diff --git a/MantidPlot/test/squish_test_suites/.gitignore b/MantidPlot/test/squish_test_suites/.gitignore
deleted file mode 100644
index 5509140f2ce4ffc5aa4c77e35093e5744c301b90..0000000000000000000000000000000000000000
--- a/MantidPlot/test/squish_test_suites/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-*.DS_Store
diff --git a/MantidPlot/test/squish_test_suites/refl_gui_tests/envvars b/MantidPlot/test/squish_test_suites/refl_gui_tests/envvars
deleted file mode 100644
index 7554408f3b0767df5d41476612ab45eb5dca25e4..0000000000000000000000000000000000000000
--- a/MantidPlot/test/squish_test_suites/refl_gui_tests/envvars
+++ /dev/null
@@ -1,2 +0,0 @@
-LD_LIBRARY_PATH=/opt/mantidnightly/lib/paraview-5.4:/opt/mantidnightly/plugins/qtplugins/mantid
-QT_API=pyqt
diff --git a/MantidPlot/test/squish_test_suites/refl_gui_tests/objects.map b/MantidPlot/test/squish_test_suites/refl_gui_tests/objects.map
deleted file mode 100644
index 86c4386d3083c0a254b6311c317716363297e295..0000000000000000000000000000000000000000
--- a/MantidPlot/test/squish_test_suites/refl_gui_tests/objects.map
+++ /dev/null
@@ -1,47 +0,0 @@
-:1_HeaderViewItem {container=':tableMain_QHeaderView' text='1' type='HeaderViewItem'}
-:2_HeaderViewItem {container=':tableMain_QHeaderView' text='2' type='HeaderViewItem'}
-:Discard_QPushButton {text='Discard' type='QPushButton' unnamed='1' visible='1' window=':_QMessageBox_2'}
-:Don't Save_QPushButton {text='Don\\'t Save' type='QPushButton' unnamed='1' visible='1' window=':_QMessageBox_2'}
-:ISIS Reflectometry (Old) - DEPRECATED.splitterList_QSplitter {name='splitterList' type='QSplitter' visible='1' window=':ISIS Reflectometry (Old) - DEPRECATED_ReflGui'}
-:ISIS Reflectometry (Old) - DEPRECATED_ReflGui {name='windowRefl' type='ReflGui' visible='1' windowTitle='ISIS Reflectometry (Old) - DEPRECATED'}
-:ISIS Reflectometry (Old).splitterList_QSplitter {name='splitterList' type='QSplitter' visible='1' window=':ISIS Reflectometry (Old)_ReflGui'}
-:ISIS Reflectometry (Old)_ReflGui {name='windowRefl' type='ReflGui' visible='1' windowTitle='ISIS Reflectometry (Old)'}
-:ISIS Reflectometry.File_QMenu {name='menuFile' title='File' type='QMenu' visible='1' window=':ISIS Reflectometry_ReflGui'}
-:ISIS Reflectometry.Instrument:_QLabel {name='labelInstrument' text='Instrument:' type='QLabel' visible='1' window=':ISIS Reflectometry_ReflGui'}
-:ISIS Reflectometry.menuBar_QMenuBar {name='menuBar' type='QMenuBar' visible='1' window=':ISIS Reflectometry_ReflGui'}
-:ISIS Reflectometry.splitterList_QSplitter {name='splitterList' type='QSplitter' visible='1' window=':ISIS Reflectometry_ReflGui'}
-:ISIS Reflectometry_ReflGui {name='windowRefl' type='ReflGui' visible='1' windowTitle='ISIS Reflectometry'}
-:Interfaces.Reflectometry_QMenu {name='ReflectometryMenu' title='Reflectometry' type='QMenu' visible='1' window=':MantidPlot - untitled.Interfaces_QMenu'}
-:MantidPlot - untitled.Interfaces_QMenu {name='interfaceMenu' title='Interfaces' type='QMenu' visible='1' window=':MantidPlot - untitled_ApplicationWindow_2'}
-:MantidPlot - untitled.WorkspaceContextMenu_QMenu {name='WorkspaceContextMenu' type='QMenu' visible='1' window=':MantidPlot - untitled_ApplicationWindow_2'}
-:MantidPlot - untitled.Workspaces_MantidDockWidget {name='exploreMantid' type='QWorkspaceDockView' visible='1' window=':MantidPlot - untitled_ApplicationWindow_2' windowTitle='Workspaces'}
-:MantidPlot - untitled.Workspaces_MantidQt::MantidWidgets::QWorkspaceDockView {name='exploreMantid' type='MantidQt::MantidWidgets::QWorkspaceDockView' visible='1' window=':MantidPlot - untitled_ApplicationWindow_2' windowTitle='Workspaces'}
-:MantidPlot - untitled.Workspaces_QDockWidget {name='exploreMantid' type='QDockWidget' visible='1' window=':MantidPlot - untitled_ApplicationWindow_2' windowTitle='Workspaces'}
-:MantidPlot - untitled_ApplicationWindow {name='main application' type='ApplicationWindow' visible='0' windowTitle='MantidPlot - untitled'}
-:MantidPlot - untitled_ApplicationWindow_2 {name='main application' type='ApplicationWindow' visible='1' windowTitle='MantidPlot - untitled'}
-:Open Table_QFileDialog {name='QFileDialog' type='QFileDialog' visible='0' windowTitle='Open Table'}
-:RenameWorkspace input dialog.Run_QPushButton {text='Run' type='QPushButton' unnamed='1' visible='1' window=':RenameWorkspace input dialog_MantidQt::API::GenericDialog'}
-:RenameWorkspace input dialog_MantidQt::API::GenericDialog {type='MantidQt::API::GenericDialog' unnamed='1' visible='1' windowTitle='RenameWorkspace input dialog'}
-:RenameWorkspace input dialog_QPushButton {type='QPushButton' unnamed='1' visible='1' window=':RenameWorkspace input dialog_MantidQt::API::GenericDialog'}
-:Workspaces.WorkspaceTreeWidget_MantidTreeWidget {container=':MantidPlot - untitled.Workspaces_QDockWidget' name='WorkspaceTree' type='MantidQt::MantidWidgets::MantidTreeWidget' visible='1'}
-:Workspaces.WorkspaceTree_MantidTreeWidget {container=':MantidPlot - untitled.Workspaces_MantidQt::MantidWidgets::QWorkspaceDockView' name='WorkspaceTree' type='MantidQt::MantidWidgets::MantidTreeWidget' visible='1'}
-:_QMenuBar {type='QMenuBar' unnamed='1' visible='1'}
-:_QMessageBox {type='QMessageBox' unnamed='1' visible='0'}
-:_QMessageBox_2 {type='QMessageBox' unnamed='1' visible='1'}
-:comboInstrument_QComboBox {buddy=':ISIS Reflectometry.Instrument:_QLabel' name='comboInstrument' type='QComboBox' visible='1'}
-:splitterList.Process_QPushButton {container=':ISIS Reflectometry.splitterList_QSplitter' name='buttonProcess' text='Process' type='QPushButton' visible='1'}
-:splitterList.buttonProcess_QPushButton {container=':ISIS Reflectometry (Old) - DEPRECATED.splitterList_QSplitter' name='buttonProcess' text='Process' type='QPushButton' visible='1'}
-:splitterList.tableMain_QTableWidget {container=':ISIS Reflectometry.splitterList_QSplitter' name='tableMain' type='QTableWidget' visible='1'}
-:splitterList.tableMain_QTableWidget_2 {container=':ISIS Reflectometry (Old).splitterList_QSplitter' name='tableMain' type='QTableWidget' visible='1'}
-:splitterList.tableMain_QTableWidget_3 {container=':ISIS Reflectometry (Old) - DEPRECATED.splitterList_QSplitter' name='tableMain' type='QTableWidget' visible='1'}
-:splitterList.widgetBottomRight_QWidget {container=':ISIS Reflectometry.splitterList_QSplitter' name='widgetBottomRight' type='QWidget' visible='1'}
-:tableMain.Plot_QPushButton {container=':splitterList.tableMain_QTableWidget_3' text='Plot' type='QPushButton' unnamed='1' visible='1'}
-:tableMain.Yes_QPushButton {container=':splitterList.tableMain_QTableWidget_3' text='Yes' type='QPushButton' unnamed='1' visible='1'}
-:tableMain_QCheckBox {container=':splitterList.tableMain_QTableWidget_3' type='QCheckBox' unnamed='1' visible='1'}
-:tableMain_QExpandingLineEdit {columnIndex='0' container=':splitterList.tableMain_QTableWidget' rowIndex='0' type='QExpandingLineEdit' unnamed='1' visible='1'}
-:tableMain_QExpandingLineEdit_2 {columnIndex='1' container=':splitterList.tableMain_QTableWidget' rowIndex='0' type='QExpandingLineEdit' unnamed='1' visible='1'}
-:tableMain_QExpandingLineEdit_3 {columnIndex='2' container=':splitterList.tableMain_QTableWidget' rowIndex='0' type='QExpandingLineEdit' unnamed='1' visible='1'}
-:tableMain_QExpandingLineEdit_4 {columnIndex='5' container=':splitterList.tableMain_QTableWidget' rowIndex='0' type='QExpandingLineEdit' unnamed='1' visible='1'}
-:tableMain_QExpandingLineEdit_5 {columnIndex='7' container=':splitterList.tableMain_QTableWidget' rowIndex='0' type='QExpandingLineEdit' unnamed='1' visible='1'}
-:tableMain_QHeaderView {container=':splitterList.tableMain_QTableWidget' orientation='2' type='QHeaderView' unnamed='1' visible='1'}
-:tableMain_QScrollBar {container=':splitterList.tableMain_QTableWidget' type='QScrollBar' unnamed='1' visible='1'}
diff --git a/MantidPlot/test/squish_test_suites/refl_gui_tests/suite.conf b/MantidPlot/test/squish_test_suites/refl_gui_tests/suite.conf
deleted file mode 100644
index dea99874cc596871350cb73387d246d008d7028d..0000000000000000000000000000000000000000
--- a/MantidPlot/test/squish_test_suites/refl_gui_tests/suite.conf
+++ /dev/null
@@ -1,9 +0,0 @@
-AUT=MantidPlot_exe
-CWD=<AUT_path>
-ENVVARS=envvars
-HOOK_SUB_PROCESSES=false
-IMPLICITAUTSTART=0
-LANGUAGE=Python
-TEST_CASES=tst_basic_operation tst_case1 tst_case1
-VERSION=3
-WRAPPERS=Qt
diff --git a/MantidPlot/test/squish_test_suites/refl_gui_tests/tst_basic_operation/test.py b/MantidPlot/test/squish_test_suites/refl_gui_tests/tst_basic_operation/test.py
deleted file mode 100644
index e46bd944b64f8e862abb7e630deaa9a29820db6c..0000000000000000000000000000000000000000
--- a/MantidPlot/test/squish_test_suites/refl_gui_tests/tst_basic_operation/test.py
+++ /dev/null
@@ -1,262 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-import re
-
-
-class ReflTestHarness:
- '''
- Test harness does common work associated with setting up the GUI environment for testing.
- '''
-
- def __init__(self):
- pass
-
- def setup_application(self):
- startApplication("MantidPlot_exe")
-
- def tear_down_application(self):
- sendEvent("QCloseEvent", waitForObject(":MantidPlot - untitled_ApplicationWindow_2"))
-
- def __setup(self):
- activateItem(waitForObjectItem(":_QMenuBar", "Interfaces"))
- activateItem(waitForObjectItem(":MantidPlot - untitled.Interfaces_QMenu", "Reflectometry"))
- refl_gui = waitForObjectItem(":Interfaces.Reflectometry_QMenu", "ISIS Reflectometry Old")
- activateItem(refl_gui)
-
- def process_everything(self):
- # Hit process
- clickButton(waitForObject(":splitterList.buttonProcess_QPushButton"))
- # Agree to process everything
- setWindowState(waitForObject(":_QMessageBox"), WindowState.Normal)
- clickButton(waitForObject(":tableMain.Yes_QPushButton"))
-
- def __teardown(self):
- sendEvent("QCloseEvent", waitForObject(":ISIS Reflectometry (Old) - DEPRECATED_ReflGui"))
- dont_save_name = ":Don't Save_QPushButton"
- if(object.exists(dont_save_name)):
- clickButton(waitForObject(dont_save_name))
- else:
- clickButton(waitForObject(":Discard_QPushButton"))
-
- def run_test(self,test_func):
- self.__setup()
- test_func(self)
- self.__teardown()
-
- def list_from_workspace_list(self):
- item_names = list()
- workspace_tree = waitForObject(":Workspaces.WorkspaceTreeWidget_MantidTreeWidget")
-
- topItem = workspace_tree.topLevelItem(0)
- item = topItem
- i = 0
- while i < workspace_tree.topLevelItemCount:
- item_names.append(item.text(0))
- item = workspace_tree.itemBelow(item)
- i += 1
-
- return item_names
-
- def filter_out_workspaces(self, run_number):
- filtered = list()
- workspaces = self.list_from_workspace_list()
- for ws in workspaces:
- if re.search(str(run_number), str(ws)):
- filtered.append(str(ws))
- return filtered
-
-
-def do_test_minimal(test_harness):
- '''Enter a single run number into the table and process it.'''
-
- run_number = 13460
- row_index = 0
- column_index = 0
-
- # Fetch the table
- tbl = waitForObject("{name='tableMain' type='QTableWidget'}")
-
- # Set the run number
- tbl.item(row_index, column_index).setText(str(run_number))
-
- # Process everything
- test_harness.process_everything()
-
- # Get a handle to the workspace list
- out_workspaces = test_harness.list_from_workspace_list()
-
- out_workspaces_from_run = test_harness.filter_out_workspaces(run_number)
-
- # Check the output workspaces are in the workspace list
- test.verify(str(run_number) + '_IvsQ' in out_workspaces_from_run, '{0}_IvsQ should exist in output'.format(run_number))
- test.verify(str(run_number) +'_IvsLam' in out_workspaces_from_run,'{0}_IvsLam should exist in output'.format(run_number))
- test.verify('TOF' in out_workspaces, 'Should have a TOF group in the output')
- test.compare(len(out_workspaces), len(out_workspaces_from_run)+1, "All workspaces in output list should be accounted for")
-
- btn = waitForObject(':tableMain.Plot_QPushButton')
- test.verify(btn.isEnabled(), 'Should be able to plot the result')
-
-def do_test_transmission(test_harness):
- '''Enter a single run with transmission correction applied.'''
- run_number = 13460
- transmission_run1 = 13463
- transmission_run2 = 13464
- row_index = 0
-
- # Fetch the table
- tbl = waitForObject("{name='tableMain' type='QTableWidget'}")
-
- # Set the run number
- tbl.item(row_index, 0).setText(str(run_number))
- # Set the transmission runs
- tbl.item(row_index, 2).setText("{0},{1}".format(transmission_run1, transmission_run2))
-
- # Process everything
- test_harness.process_everything()
-
- # Get a handle to the workspace list
- out_workspaces = test_harness.list_from_workspace_list()
-
- # Check the output workspaces are in the workspace list
- test.verify(str(run_number) + '_IvsQ' in out_workspaces,'{0}_IvsQ should exist in output'.format(run_number))
- test.verify(str(run_number) +'_IvsLam' in out_workspaces,'{0}_IvsLam dshould exist in output'.format(run_number))
- test.verify('TRANS_{0}_{1}'.format(transmission_run1, transmission_run2) in out_workspaces,'Transmission workspace should exist in output')
-
-def do_test_reuse_transmission(test_harness):
- '''Enter two runs and recycle the transmission runs in two different ways.
- Depends upon the output from the previous test which created the transmission runs'''
-
- run_number1 = 13460
- run_number2 = 13462
- transmission_run1 = 13463
- transmission_run2 = 13464
- row_index = 0
-
- # Fetch the table
- tbl = waitForObject("{name='tableMain' type='QTableWidget'}")
-
- # Set the first run number
- tbl.item(row_index, 0).setText(str(run_number1))
-
- # Set the second run number
- tbl.item(row_index, 5).setText(str(run_number2))
- # Set the transmission runs AS their workspace name
- tbl.item(row_index, 2).setText('TRANS_{0}_{1}'.format(transmission_run1, transmission_run2))
- # Set the transmission runs AS their run numbers. Should be recycled anyway as the transmission workspace already exists.
- tbl.item(row_index, 7).setText('{0},{1}'.format(transmission_run1, transmission_run2))
-
- # Process everything
- test_harness.process_everything()
-
- # Get a handle to the workspace list
- out_workspaces = test_harness.list_from_workspace_list()
-
- # Check the output workspaces are in the workspace list
- test.verify(str(run_number1) + '_IvsQ' in out_workspaces,'{0}_IvsQ should exist in output'.format(run_number1))
- test.verify(str(run_number1) +'_IvsLam' in out_workspaces,'{0}_IvsLam should exist in output'.format(run_number1))
- test.verify(str(run_number2) + '_IvsQ' in out_workspaces,'{0}_IvsQ should exist in output'.format(run_number2))
- test.verify(str(run_number2) +'_IvsLam' in out_workspaces,'{0}_IvsLam should exist in output'.format(run_number2))
- test.verify('TRANS_{0}_{1}'.format(transmission_run1, transmission_run2) in out_workspaces,'Transmission workspace should exist in output')
-
-def do_test_stitch_output(test_harness):
- '''Check stitching'''
-
- run_number1 = 13460
- run_number2 = 13462
- transmission_run1 = 13463
- transmission_run2 = 13464
- row_index = 0
-
- # Fetch the table
- tbl = waitForObject("{name='tableMain' type='QTableWidget'}")
-
- # Set the stitched state
- ck_stitched = waitForObject(':tableMain_QCheckBox')
- ck_stitched.setChecked(True)
-
- # Set the first run number
- tbl.item(row_index, 0).setText(str(run_number1))
-
- # Set the second run number
- tbl.item(row_index, 5).setText(str(run_number2))
- # Set the transmission runs AS their workspace name
- tbl.item(row_index, 2).setText('TRANS_{0}_{1}'.format(transmission_run1, transmission_run2))
- # Set the transmission runs AS their run numbers. Should be recycled anyway as the transmission workspace already exists.
- tbl.item(row_index, 7).setText('TRANS_{0}_{1}'.format(transmission_run1, transmission_run2))
-
- # Process everything
- test_harness.process_everything()
-
- # Get a handle to the workspace list
- out_workspaces = test_harness.list_from_workspace_list()
-
- # Check the output workspaces are in the workspace list
- test.verify(str(run_number1) + '_IvsQ' in out_workspaces,'{0}_IvsQ should exist in output'.format(run_number1))
- test.verify(str(run_number1) +'_IvsLam' in out_workspaces,'{0}_IvsLam should exist in output'.format(run_number1))
- test.verify(str(run_number2) + '_IvsQ' in out_workspaces,'{0}_IvsQ should exist in output'.format(run_number2))
- test.verify(str(run_number2) +'_IvsLam' in out_workspaces,'{0}_IvsLam should exist in output'.format(run_number2))
- test.verify('TRANS_{0}_{1}'.format(transmission_run1, transmission_run2) in out_workspaces,'Transmission workspace should exist in output')
- # Test that the stitched workspace is generated.
- test.verify('13460_62' in out_workspaces,'Stitched workspace should be generated')
-
-def do_test_three_runs(test_harness):
- '''Check stitching'''
-
- run_number1 = 13460
- run_number2 = 13462
- run_number3 = 13463
-
- row_index = 0
-
- # Fetch the table
- tbl = waitForObject("{name='tableMain' type='QTableWidget'}")
-
- # Set the first run number
- tbl.item(row_index, 0).setText(str(run_number1))
-
- # Set the second run number
- tbl.item(row_index, 5).setText(str(run_number2))
-
- # Set the third run number
- tbl.item(row_index, 10).setText(str(run_number3))
- # Give the third run a theta value
- tbl.item(row_index, 11).setText(str(1.0))
-
- # Process everything
- test_harness.process_everything()
-
- # Get a handle to the workspace list
- out_workspaces = test_harness.list_from_workspace_list()
-
- # Check the output workspaces are in the workspace list
- test.verify(str(run_number1) + '_IvsQ' in out_workspaces,'{0}_IvsQ should exist in output'.format(run_number1))
- test.verify(str(run_number1) +'_IvsLam' in out_workspaces,'{0}_IvsLam should exist in output'.format(run_number1))
- test.verify(str(run_number2) + '_IvsQ' in out_workspaces,'{0}_IvsQ should exist in output'.format(run_number2))
- test.verify(str(run_number2) +'_IvsLam' in out_workspaces,'{0}_IvsLam should exist in output'.format(run_number2))
- test.verify(str(run_number3) + '_IvsQ' in out_workspaces,'{0}_IvsQ should exist in output'.format(run_number3))
- test.verify(str(run_number3) +'_IvsLam' in out_workspaces,'{0}_IvsLam should exist in output'.format(run_number3))
-def main():
- # Create the test harness
- test_app = ReflTestHarness()
- # Get the application ready
- test_app.setup_application()
-
- '''
- Run tests
- '''
- test_app.run_test(do_test_minimal)
- test_app.run_test(do_test_transmission)
- test_app.run_test(do_test_reuse_transmission)
- test_app.run_test(do_test_stitch_output)
- test_app.run_test(do_test_three_runs)
-
- # Clean up
- test_app.tear_down_application()
-
-
-
-
diff --git a/Testing/Data/SystemTest/BenzeneBinWidthCASTEP.nxs.md5 b/Testing/Data/SystemTest/BenzeneBinWidthCASTEP.nxs.md5
index 2894a7a5302ff03cd1c872e49b07f5d72b8a4563..bca3dbb284d435324e5af1b41117e03406f98d2c 100644
--- a/Testing/Data/SystemTest/BenzeneBinWidthCASTEP.nxs.md5
+++ b/Testing/Data/SystemTest/BenzeneBinWidthCASTEP.nxs.md5
@@ -1 +1 @@
-8c4c9164cbd6256b8fe558a8cc5aab2f
+3927dcd4999b921628501dad08ff140d
diff --git a/Testing/Data/SystemTest/C6H5Cl-Gaussian.nxs.md5 b/Testing/Data/SystemTest/C6H5Cl-Gaussian.nxs.md5
index f1e705becf4e102b0739c5c63ce4866db79d13b1..e6fdb2e26a05001e7e3bbafdda2de2c9e421b2de 100644
--- a/Testing/Data/SystemTest/C6H5Cl-Gaussian.nxs.md5
+++ b/Testing/Data/SystemTest/C6H5Cl-Gaussian.nxs.md5
@@ -1 +1 @@
-426766659eb52b2cdca5f4c452269af6
+2d0ba9a56ef63248031cc24fb2c10fe8
diff --git a/Testing/Data/SystemTest/HRP39180.RAW.md5 b/Testing/Data/SystemTest/HRP39180.RAW.md5
deleted file mode 100644
index 027bfb088aac7e6ab9171183d0bd1670e9241e12..0000000000000000000000000000000000000000
--- a/Testing/Data/SystemTest/HRP39180.RAW.md5
+++ /dev/null
@@ -1 +0,0 @@
-7d19937fbfb68e962c190454a128fde6
\ No newline at end of file
diff --git a/Testing/Data/SystemTest/Na2SiF6_CASTEP.nxs.md5 b/Testing/Data/SystemTest/Na2SiF6_CASTEP.nxs.md5
index 406a60d0ad2b5df99d2273ebe8444bf26f6d7c35..9e4f8de20bc154a9f73fa0c16831de8c44118025 100644
--- a/Testing/Data/SystemTest/Na2SiF6_CASTEP.nxs.md5
+++ b/Testing/Data/SystemTest/Na2SiF6_CASTEP.nxs.md5
@@ -1 +1 @@
-6a9ebb184ce6cbad194d2f4217e8e6c2
+e6669ec5dd49fc7f2c835ba3a6ff707b
diff --git a/Testing/Data/SystemTest/Na2SiF6_DMOL3.nxs.md5 b/Testing/Data/SystemTest/Na2SiF6_DMOL3.nxs.md5
index 17ae498c9f66c478e2779493ba53b437b8cd1b8e..3afc071803b0df558372b8d51228f872c5daaa35 100644
--- a/Testing/Data/SystemTest/Na2SiF6_DMOL3.nxs.md5
+++ b/Testing/Data/SystemTest/Na2SiF6_DMOL3.nxs.md5
@@ -1 +1 @@
-23947afbbcec326052018f34551993a3
+6e851997cfba0cec009e307fa1c95031
diff --git a/Testing/Data/SystemTest/TolueneLargerOrderAbins.nxs.md5 b/Testing/Data/SystemTest/TolueneLargerOrderAbins.nxs.md5
index 6f162e65e2187871e7d09931033ba4c62dc8501c..14b889dca0b8fbc5180b32d3967651334850be96 100644
--- a/Testing/Data/SystemTest/TolueneLargerOrderAbins.nxs.md5
+++ b/Testing/Data/SystemTest/TolueneLargerOrderAbins.nxs.md5
@@ -1 +1 @@
-7031da500c989b8ee3b7e884ab12426c
+28ec7e6f3b4ff61f50d1eecdaf133471
diff --git a/Testing/Data/SystemTest/TolueneScale.nxs.md5 b/Testing/Data/SystemTest/TolueneScale.nxs.md5
index 9e1652d98002743d739737cb348e7c1e0fb74546..2dedd23c2f93c5fd6c14b2f83c1e9574f127d32a 100644
--- a/Testing/Data/SystemTest/TolueneScale.nxs.md5
+++ b/Testing/Data/SystemTest/TolueneScale.nxs.md5
@@ -1 +1 @@
-d1a0e156844c6459d230763742e21080
+e40d2e8696fe8608beea25299e3007c0
diff --git a/Testing/Data/SystemTest/TolueneScratchAbins.nxs.md5 b/Testing/Data/SystemTest/TolueneScratchAbins.nxs.md5
index ffd48113c4d5f8b80826ad666eca4a60f2c17b97..4d0cf21948d00106eb22702db9ac89465ec01127 100644
--- a/Testing/Data/SystemTest/TolueneScratchAbins.nxs.md5
+++ b/Testing/Data/SystemTest/TolueneScratchAbins.nxs.md5
@@ -1 +1 @@
-ab23cd079e36f46dd610dc22a9d8beac
+c8a50f44d2b3300eb26e1a891c8c60fe
diff --git a/Testing/SystemTests/tests/analysis/AbinsTest.py b/Testing/SystemTests/tests/analysis/AbinsTest.py
index 0886c66a1425108f89d39c7d7829c2ddf2d25751..b13bb4113e6e9b987e7bd2f8cd5a59461cf9966a 100644
--- a/Testing/SystemTests/tests/analysis/AbinsTest.py
+++ b/Testing/SystemTests/tests/analysis/AbinsTest.py
@@ -176,7 +176,7 @@ class AbinsCRYSTALTestScratch(systemtesting.MantidSystemTest, HelperTestingClass
self.ref_result = name + ".nxs"
self.set_ab_initio_program("CRYSTAL")
self.set_name(name)
- self.set_order(AbinsConstants.QUANTUM_ORDER_FOUR)
+ self.set_order(AbinsConstants.QUANTUM_ORDER_TWO)
self.case_from_scratch()
def excludeInPullRequests(self):
@@ -263,8 +263,8 @@ class AbinsCRYSTALTestLargerOrder(systemtesting.MantidSystemTest, HelperTestingC
self.ref_result = name + ".nxs"
self.set_ab_initio_program("CRYSTAL")
self.set_name(name)
- self.set_order(AbinsConstants.QUANTUM_ORDER_TWO)
- self.case_restart_diff_order(AbinsConstants.QUANTUM_ORDER_THREE)
+ self.set_order(AbinsConstants.QUANTUM_ORDER_ONE)
+ self.case_restart_diff_order(AbinsConstants.QUANTUM_ORDER_TWO)
def excludeInPullRequests(self):
return True
@@ -343,7 +343,7 @@ class AbinsCASTEPNoH(systemtesting.MantidSystemTest, HelperTestingClass):
self.ref_result = name + ".nxs"
self.set_ab_initio_program("CASTEP")
self.set_name(name)
- self.set_order(AbinsConstants.QUANTUM_ORDER_FOUR)
+ self.set_order(AbinsConstants.QUANTUM_ORDER_TWO)
self.set_cross_section(cross_section="Total")
self.case_from_scratch()
self._wrk_1 = self._output_name
@@ -394,7 +394,7 @@ class AbinsDMOL3TestScratch(systemtesting.MantidSystemTest, HelperTestingClass):
self.ref_result = name + ".nxs"
self.set_ab_initio_program("DMOL3")
self.set_name(name)
- self.set_order(AbinsConstants.QUANTUM_ORDER_FOUR)
+ self.set_order(AbinsConstants.QUANTUM_ORDER_TWO)
self.set_cross_section(cross_section="Total")
self.case_from_scratch()
@@ -422,7 +422,7 @@ class AbinsGAUSSIANestScratch(systemtesting.MantidSystemTest, HelperTestingClass
self.ref_result = name + ".nxs"
self.set_ab_initio_program("GAUSSIAN")
self.set_name(name)
- self.set_order(AbinsConstants.QUANTUM_ORDER_FOUR)
+ self.set_order(AbinsConstants.QUANTUM_ORDER_TWO)
self.set_cross_section(cross_section="Incoherent")
self.case_from_scratch()
diff --git a/Testing/SystemTests/tests/analysis/EnggCalibrationTest.py b/Testing/SystemTests/tests/analysis/EnggCalibrationTest.py
index 23da04486964b7c8920c2b7c904fbe2c36770563..97666d827dc9b5a62b8db369dd98eeea9f7a7d12 100644
--- a/Testing/SystemTests/tests/analysis/EnggCalibrationTest.py
+++ b/Testing/SystemTests/tests/analysis/EnggCalibrationTest.py
@@ -244,7 +244,7 @@ class EnginXCalibrateFullThenCalibrateTest(systemtesting.MantidSystemTest):
self.assertEqual(cell_val[-2:], '}}')
# this will be used as a comparison delta in relative terms (percentage)
- exdelta_special = 5e-4
+ exdelta_special = 5e-3
# Mac fitting tests produce large differences for some reason.
# Windows results are different but within reasonable bounds
import sys
@@ -294,23 +294,40 @@ class EnginXCalibrateFullThenCalibrateTest(systemtesting.MantidSystemTest):
self.assertTrue(abs(self.pos_table.cell(1199, 9)) < 15)
# === check difc, zero parameters for GSAS produced by EnggCalibrate
- # Bank 1
- self.assertTrue(rel_err_less_delta(self.difa, 2.3265842459, exdelta_special),
- "difa parameter for bank 1 is not what was expected, got: %f" % self.difa)
- self.assertTrue(rel_err_less_delta(self.difc, 18440.5718578, exdelta_special),
- "difc parameter for bank 1 is not what was expected, got: %f" % self.difc)
- if "darwin" != sys.platform:
+ if sys.platform == "win32": # Windows performs the fit differently enough to cause problems.
+ # Bank 1
+ self.assertTrue(rel_err_less_delta(self.difa, 2.31176809660, exdelta_special),
+ "difa parameter for bank 1 is not what was expected, got: %f" % self.difa)
+ self.assertTrue(rel_err_less_delta(self.difc, 18440.6101707, exdelta_special),
+ "difc parameter for bank 1 is not what was expected, got: %f" % self.difc)
self.assertTrue(abs(self.zero) < 40,
"zero parameter for bank 1 is not what was expected, got: %f" % self.zero)
- # Bank 2
- self.assertTrue(rel_err_less_delta(self.difa_b2, 3.9220236519, exdelta_special),
- "difa parameter for bank 2 is not what was expected, got: %f" % self.difa_b2)
- self.assertTrue(rel_err_less_delta(self.difc_b2, 18382.7105215, exdelta_special),
- "difc parameter for bank 2 is not what was expected, got: %f" % self.difc_b2)
- if "darwin" != sys.platform:
+ # Bank 2
+ self.assertTrue(rel_err_less_delta(self.difa_b2, 3.92202365197, exdelta_special),
+ "difa parameter for bank 2 is not what was expected, got: %f" % self.difa_b2)
+ self.assertTrue(rel_err_less_delta(self.difc_b2, 18382.7105214, exdelta_special),
+ "difc parameter for bank 2 is not what was expected, got: %f" % self.difc_b2)
self.assertTrue(abs(self.zero_b2) < 10,
"zero parameter for bank 2 is not what was expected, got: %f" % self.zero_b2)
+ else:
+ # Bank 1
+ self.assertTrue(rel_err_less_delta(self.difa, 2.3265842459, exdelta_special),
+ "difa parameter for bank 1 is not what was expected, got: %f" % self.difa)
+ self.assertTrue(rel_err_less_delta(self.difc, 18440.5718578, exdelta_special),
+ "difc parameter for bank 1 is not what was expected, got: %f" % self.difc)
+ if "darwin" != sys.platform:
+ self.assertTrue(abs(self.zero) < 40,
+ "zero parameter for bank 1 is not what was expected, got: %f" % self.zero)
+
+ # Bank 2
+ self.assertTrue(rel_err_less_delta(self.difa_b2, 3.9220236519, exdelta_special),
+ "difa parameter for bank 2 is not what was expected, got: %f" % self.difa_b2)
+ self.assertTrue(rel_err_less_delta(self.difc_b2, 18382.7105215, exdelta_special),
+ "difc parameter for bank 2 is not what was expected, got: %f" % self.difc_b2)
+ if "darwin" != sys.platform:
+ self.assertTrue(abs(self.zero_b2) < 10,
+ "zero parameter for bank 2 is not what was expected, got: %f" % self.zero_b2)
# === peaks used to fit the difc and zero parameters ===
expected_peaks = [1.1046, 1.3528, 1.5621, 1.6316, 2.7057]
diff --git a/Testing/SystemTests/tests/analysis/INTERReductionTest.py b/Testing/SystemTests/tests/analysis/INTERReductionTest.py
index 2834509c7a650b837b6f6801c82d32e131d732cb..327b823d1d2b0e18afa7847838b7999e351d1a3f 100644
--- a/Testing/SystemTests/tests/analysis/INTERReductionTest.py
+++ b/Testing/SystemTests/tests/analysis/INTERReductionTest.py
@@ -106,13 +106,16 @@ def eventRef(run_number, angle, start=0, stop=0, DB='TRANS'):
ReflectometryISISLoadAndProcess(InputRunList=slice_name, FirstTransmissionRunList=DB,
OutputWorkspaceBinned=slice_name+'_ref_binned',
OutputWorkspace=slice_name+'_ref',
- OutputWorkspaceWavelength=slice_name+'_lam', Debug=True)
+ OutputWorkspaceWavelength=slice_name+'_lam',
+ OutputWorkspaceTransmission=DB+'_LAM',
+ Debug=True)
# Delete interim workspaces
DeleteWorkspace(slice_name+'_lam')
DeleteWorkspace(slice_name)
DeleteWorkspace(slice_name+'_ref')
DeleteWorkspace('mon_slice')
DeleteWorkspace('mon_rebin')
+ DeleteWorkspace(DB+'_LAM')
def quickRef(run_numbers=[], trans_workspace_names=[], angles=[]):
@@ -122,11 +125,13 @@ def quickRef(run_numbers=[], trans_workspace_names=[], angles=[]):
for run_index in range(len(run_numbers)):
# Set up the reduction properties
run_name=str(run_numbers[run_index])
+ trans_name = str(trans_workspace_names[run_index])
properties = {'InputRunList': run_name+'.raw',
- 'FirstTransmissionRunList': str(trans_workspace_names[run_index]),
+ 'FirstTransmissionRunList': trans_name,
'OutputWorkspaceBinned': run_name+'_IvsQ_binned',
'OutputWorkspace': run_name+'_IvsQ',
'OutputWorkspaceWavelength': run_name+'_IvsLam',
+ 'OutputWorkspaceTransmission': trans_name+'_LAM',
'Debug': True}
# Set ThetaIn if the angles are given
if angles:
@@ -137,6 +142,7 @@ def quickRef(run_numbers=[], trans_workspace_names=[], angles=[]):
properties['WavelengthMin']=2.6
# Do the reduction
ReflectometryISISLoadAndProcess(**properties)
+ DeleteWorkspace(trans_name+'_LAM')
reduced_runs=reduced_runs+run_name+'_IvsQ_binned'
if run_index < len(run_numbers)-1:
reduced_runs=reduced_runs+','
diff --git a/Testing/SystemTests/tests/analysis/ISISReflectometryAutoreductionTest.py b/Testing/SystemTests/tests/analysis/ISISReflectometryAutoreductionTest.py
index 39ff2717fb919c6a7410bc6d27e9e1b5ef20a640..a26b2ea2fb9cdac1e52b38899812f2ed17b7d13e 100644
--- a/Testing/SystemTests/tests/analysis/ISISReflectometryAutoreductionTest.py
+++ b/Testing/SystemTests/tests/analysis/ISISReflectometryAutoreductionTest.py
@@ -178,7 +178,7 @@ def AutoReduce(transRun=[], runRange=[], oldList=[]):
if not mtd.doesExist(runno + '_IvsQ'):
th = angle
if len(transRun) > 1 and angle > 2.25:
- wq, wq_binned = \
+ wq, wq_unbinned, wlam, wtrans = \
ReflectometryISISLoadAndProcess(
InputRunList=ws,
FirstTransmissionRunList=transRun[1],
@@ -188,7 +188,7 @@ def AutoReduce(transRun=[], runRange=[], oldList=[]):
OutputWorkspace=runno + '_IvsQ',
OutputWorkspaceBinned=runno + '_IvsQ_binned')
else:
- wq, wqbinned = \
+ wq, wq_unbinned, wlam, wtrans = \
ReflectometryISISLoadAndProcess(
InputRunList=ws,
FirstTransmissionRunList=transRun[0],
@@ -197,6 +197,8 @@ def AutoReduce(transRun=[], runRange=[], oldList=[]):
EndOverlap=12,
OutputWorkspace=runno + '_IvsQ',
OutputWorkspaceBinned=runno + '_IvsQ_binned')
+ mtd.remove('wlam')
+ mtd.remove('wtrans')
else:
wq = mtd[runno + '_IvsQ']
th = angle
diff --git a/Testing/SystemTests/tests/analysis/SANSBatchReductionTest.py b/Testing/SystemTests/tests/analysis/SANSBatchReductionTest.py
index a8ae41c2e84a34f0da13b45432f791e5ac117424..82c494cd4ebb24a0c790ce371da91273a1ec8410 100644
--- a/Testing/SystemTests/tests/analysis/SANSBatchReductionTest.py
+++ b/Testing/SystemTests/tests/analysis/SANSBatchReductionTest.py
@@ -6,22 +6,26 @@
# SPDX - License - Identifier: GPL - 3.0 +
# pylint: disable=too-many-public-methods, invalid-name, too-many-arguments
from __future__ import (absolute_import, division, print_function)
+
import unittest
+
import systemtesting
-from mantid.api import AnalysisDataService
-from sans.sans_batch import SANSBatchReduction
-from sans.user_file.state_director import StateDirectorISIS
-from sans.state.data import get_data_builder
-from sans.common.enums import (SANSFacility, ReductionMode, OutputMode)
+from mantid.api import AnalysisDataService
from sans.common.constants import EMPTY_NAME
-from sans.common.general_functions import create_unmanaged_algorithm
+from sans.common.enums import (SANSFacility, ReductionMode, OutputMode)
from sans.common.file_information import SANSFileInformationFactory
+from sans.common.general_functions import create_unmanaged_algorithm
+from sans.sans_batch import SANSBatchReduction
+from sans.state.StateBuilder import StateBuilder
+from sans.state.StateObjects.StateData import get_data_builder
# -----------------------------------------------
# Tests for the SANSBatchReduction algorithm
# -----------------------------------------------
+
+
class SANSBatchReductionTest(unittest.TestCase):
def _run_batch_reduction(self, states, use_optimizations=False):
@@ -57,6 +61,7 @@ class SANSBatchReductionTest(unittest.TestCase):
compare_alg.setChild(False)
compare_alg.execute()
result = compare_alg.getProperty("Result").value
+
self.assertTrue(result)
def test_that_batch_reduction_evaluates_LAB(self):
@@ -77,21 +82,20 @@ class SANSBatchReductionTest(unittest.TestCase):
data_info = data_builder.build()
+ user_filename = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_filename)
+
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
+ state = user_file_director.get_all_states()
+
# Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.LAB)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ state.reduction.reduction_mode = ReductionMode.LAB
# Since we are dealing with event based data but we want to compare it with histogram data from the
# old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- state = user_file_director.construct()
+ state.compatibility.use_compatibility_mode = True # COMPATIBILITY BEGIN -- Remove when appropriate
# Act
states = [state]
@@ -117,11 +121,13 @@ class SANSBatchReductionTest(unittest.TestCase):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("MASKSANS2Doptions.091A")
+ user_filename = "MASKSANS2Doptions.091A"
+ user_file_parser = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_filename)
+ state = user_file_parser.get_all_states()
# Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.LAB)
- state = user_file_director.construct()
+ state.reduction.reduction_mode = ReductionMode.LAB
# Act
states = [state]
@@ -157,23 +163,17 @@ class SANSBatchReductionTest(unittest.TestCase):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
- # Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.LAB)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # Since we are dealing with event based data but we want to compare it with histogram data from the
- # old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- user_file_director.set_slice_event_builder_start_time([1.0,3.0])
- user_file_director.set_slice_event_builder_end_time([3.0,5.0])
+ user_filename = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_filename)
- state = user_file_director.construct()
+ state = user_file_director.get_all_states()
+ # Set the reduction mode to LAB
+ state.reduction.reduction_mode = ReductionMode.LAB
+ state.compatibility.use_compatibility_mode = True # COMPATIBILITY BEGIN -- Remove when appropriate
+ state.slice.start_time = [1.0,3.0]
+ state.slice.end_time = [3.0,5.0]
# Act
states = [state]
@@ -210,21 +210,17 @@ class SANSBatchReductionTest(unittest.TestCase):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
+ user_filename = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_filename)
+
# Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.LAB)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # Since we are dealing with event based data but we want to compare it with histogram data from the
- # old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ state = user_file_director.get_all_states()
+
+ state.reduction.reduction_mode = ReductionMode.LAB
+ state.compatibility.use_compatibility_mode = True # COMPATIBILITY BEGIN -- Remove when appropriate
- state = user_file_director.construct()
start = [1.0,2.0]
end = [2.0,3.0]
state.wavelength.wavelength_low = start
@@ -269,15 +265,17 @@ class SANSBatchReductionTest(unittest.TestCase):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("MASKSANS2Doptions.091A")
- # Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.LAB)
+ user_filename = "MASKSANS2Doptions.091A"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_filename)
- user_file_director.set_slice_event_builder_start_time([1.0, 3.0])
- user_file_director.set_slice_event_builder_end_time([3.0, 5.0])
+ state = user_file_director.get_all_states()
+ # Set the reduction mode to LAB
+ state.reduction.reduction_mode = ReductionMode.LAB
- state = user_file_director.construct()
+ state.slice.start_time = [1.0, 3.0]
+ state.slice.end_time = [3.0, 5.0]
start = [1.0, 1.0]
end = [3.0, 2.0]
diff --git a/Testing/SystemTests/tests/analysis/SANSBeamCentreFinderCoreTest.py b/Testing/SystemTests/tests/analysis/SANSBeamCentreFinderCoreTest.py
index dac357ff81a1b3dcb4769b342fc901ecbd03c903..35951c133cc30385ad02c51d8b66c7c138c0f2d7 100644
--- a/Testing/SystemTests/tests/analysis/SANSBeamCentreFinderCoreTest.py
+++ b/Testing/SystemTests/tests/analysis/SANSBeamCentreFinderCoreTest.py
@@ -14,10 +14,11 @@ import systemtesting
import mantid
from mantid.api import AlgorithmManager
from sans.state.Serializer import Serializer
+from sans.state.StateBuilder import StateBuilder
-from sans.state.data import get_data_builder
+from sans.state.StateObjects.StateData import get_data_builder
from sans.common.enums import (DetectorType, DataType, SANSFacility)
-from sans.user_file.state_director import StateDirectorISIS
+
from sans.common.constants import EMPTY_NAME
from sans.common.general_functions import create_unmanaged_algorithm
from sans.common.file_information import SANSFileInformationFactory
@@ -157,21 +158,13 @@ class SANSBeamCentreFinderCoreTest(unittest.TestCase):
data_state = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_state, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
-
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # Since we are dealing with event based data but we want to compare it with histogram data from the
- # old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
- # Construct the final state
- state = user_file_director.construct()
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(data_information=data_state,
+ file_information=file_information,
+ user_filename=user_file)
+ state = user_file_director.get_all_states()
+
+ state.compatibility.use_compatibility_mode = True
# Load the sample workspaces
workspace, workspace_monitor, transmission_workspace, direct_workspace = self._load_workspace(state)
diff --git a/Testing/SystemTests/tests/analysis/SANSDiagnosticPageTest.py b/Testing/SystemTests/tests/analysis/SANSDiagnosticPageTest.py
index b8000c278be83d96d70c3fdf4351bae520ca8155..56b1d0103981a2dbaddb660784a02c50eace943d 100644
--- a/Testing/SystemTests/tests/analysis/SANSDiagnosticPageTest.py
+++ b/Testing/SystemTests/tests/analysis/SANSDiagnosticPageTest.py
@@ -12,10 +12,11 @@ import os
import systemtesting
import mantid
+from sans.state.StateBuilder import StateBuilder
-from sans.state.data import get_data_builder
+from sans.state.StateObjects.StateData import get_data_builder
from sans.common.enums import (DetectorType, SANSFacility, IntegralEnum)
-from sans.user_file.state_director import StateDirectorISIS
+
from sans.common.constants import EMPTY_NAME
from sans.common.general_functions import create_unmanaged_algorithm
from sans.gui_logic.models.diagnostics_page_model import run_integral
@@ -88,21 +89,12 @@ class SANSDiagnosticPageTest(unittest.TestCase):
data_state = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_state, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
-
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # Since we are dealing with event based data but we want to compare it with histogram data from the
- # old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
- # Construct the final state
- state = user_file_director.construct()
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_state,
+ user_filename=user_file)
+ state = user_file_director.get_all_states()
+ state.compatibility.use_compatibility_mode = True
# Act
output_workspaces = run_integral('', True, IntegralEnum.Horizontal, DetectorType.LAB, state)
@@ -122,11 +114,13 @@ class SANSDiagnosticPageTest(unittest.TestCase):
data_state = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_state, file_information)
- user_file_director.set_user_file("USER_LARMOR_151B_LarmorTeam_80tubes_BenchRot1p4_M4_r3699.txt")
+ user_file = "USER_LARMOR_151B_LarmorTeam_80tubes_BenchRot1p4_M4_r3699.txt"
+ user_file_director = StateBuilder.new_instance(data_information=data_state,
+ file_information=file_information,
+ user_filename=user_file)
# Construct the final state
- state = user_file_director.construct()
+ state = user_file_director.get_all_states()
# Act
output_workspaces = run_integral('', True, IntegralEnum.Horizontal, DetectorType.LAB, state)
diff --git a/Testing/SystemTests/tests/analysis/SANSILLAbsoluteScaleTest.py b/Testing/SystemTests/tests/analysis/SANSILLAbsoluteScaleTest.py
new file mode 100644
index 0000000000000000000000000000000000000000..cf39d92a6b431973b2077cbb05db00883eb92f4a
--- /dev/null
+++ b/Testing/SystemTests/tests/analysis/SANSILLAbsoluteScaleTest.py
@@ -0,0 +1,144 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+from __future__ import (absolute_import, division, print_function)
+
+import systemtesting
+from mantid.simpleapi import *
+
+
+class D11_AbsoluteScale_Test(systemtesting.MantidSystemTest):
+
+ def __init__(self):
+ super(D11_AbsoluteScale_Test, self).__init__()
+ self.setUp()
+
+ def setUp(self):
+ config['default.facility'] = 'ILL'
+ config['default.instrument'] = 'D11'
+ config.appendDataSearchSubDir('ILL/D11/')
+
+ def cleanup(self):
+ mtd.clear()
+
+ def validate(self):
+ self.tolerance = 1e-5
+ self.tolerance_is_rel_err = True
+ self.disableChecking = ['Instrument']
+ return ['abs_scale_outputs', 'D11_AbsScaleReference.nxs']
+
+ def runTest(self):
+ # Load the mask
+ LoadNexusProcessed(Filename='D11_mask.nxs', OutputWorkspace='mask')
+
+ # Process the dark current Cd/B4C for water
+ SANSILLReduction(Run='010455', ProcessAs='Absorber', OutputWorkspace='Cdw')
+
+ # Process the empty beam for water
+ SANSILLReduction(Run='010414', ProcessAs='Beam', AbsorberInputWorkspace='Cdw', OutputWorkspace='Dbw',
+ FluxOutputWorkspace='Flw')
+ # Water container transmission
+ SANSILLReduction(Run='010446', ProcessAs='Transmission', AbsorberInputWorkspace='Cdw',
+ BeamInputWorkspace='Dbw', OutputWorkspace='wc_tr')
+ # Water container
+ SANSILLReduction(Run='010454', ProcessAs='Container', AbsorberInputWorkspace='Cdw',
+ BeamInputWorkspace='Dbw', TransmissionInputWorkspace='wc_tr', OutputWorkspace='wc')
+ # Water transmission
+ SANSILLReduction(Run='010445', ProcessAs='Transmission', AbsorberInputWorkspace='Cdw',
+ BeamInputWorkspace='Dbw', OutputWorkspace='w_tr')
+ # Water as reference
+ SANSILLReduction(Run='010453', ProcessAs='Sample', AbsorberInputWorkspace='Cdw', MaskedInputWorkspace='mask',
+ ContainerInputWorkspace='wc', BeamInputWorkspace='Dbw', TransmissionInputWorkspace='wc_tr',
+ SensitivityOutputWorkspace='sens', OutputWorkspace='reference', FluxInputWorkspace='Flw')
+ # Water as sample with sensitivity and flux
+ SANSILLReduction(Run='010453', ProcessAs='Sample', AbsorberInputWorkspace='Cdw', MaskedInputWorkspace='mask',
+ ContainerInputWorkspace='wc', BeamInputWorkspace='Dbw', TransmissionInputWorkspace='wc_tr',
+ SensitivityInputWorkspace='sens', OutputWorkspace='water_with_sens_flux', FluxInputWorkspace='Flw')
+ # Water with itself as reference and flux
+ SANSILLReduction(Run='010453', ProcessAs='Sample', AbsorberInputWorkspace='Cdw', MaskedInputWorkspace='mask',
+ ContainerInputWorkspace='wc', BeamInputWorkspace='Dbw', TransmissionInputWorkspace='wc_tr',
+ ReferenceInputWorkspace='reference', OutputWorkspace='water_with_reference', FluxInputWorkspace='Flw')
+
+ # Group the worksaces
+ GroupWorkspaces(InputWorkspaces=['sens', 'reference', 'water_with_reference', 'water_with_sens_flux'],
+ OutputWorkspace='abs_scale_outputs')
+
+
+class D11_AbsoluteScaleFlux_Test(systemtesting.MantidSystemTest):
+
+ def __init__(self):
+ super(D11_AbsoluteScaleFlux_Test, self).__init__()
+ self.setUp()
+
+ def setUp(self):
+ config['default.facility'] = 'ILL'
+ config['default.instrument'] = 'D11'
+ config.appendDataSearchSubDir('ILL/D11/')
+
+ def cleanup(self):
+ mtd.clear()
+
+ def runTest(self):
+ # Load the mask
+ LoadNexusProcessed(Filename='D11_mask.nxs', OutputWorkspace='mask')
+
+ # Calculate flux for water
+ SANSILLReduction(Run='010414', ProcessAs='Beam', OutputWorkspace='Dbw', FluxOutputWorkspace='flw')
+
+ # Reduce water with flux normalisation
+ SANSILLReduction(Run='010453', ProcessAs='Sample', MaskedInputWorkspace='mask',
+ OutputWorkspace='water_with_flux', FluxInputWorkspace='flw')
+
+ # Reduce water without flux normalisation
+ SANSILLReduction(Run='010453', ProcessAs='Sample', MaskedInputWorkspace='mask', OutputWorkspace='water_wo_flux')
+
+ # Calculate flux for sample
+ SANSILLReduction(Run='010413', ProcessAs='Beam', OutputWorkspace='Db', FluxOutputWorkspace='fl')
+
+ # Reduce sample with flux normalisation and flux normalised water reference
+ SANSILLReduction(Run='010569', ProcessAs='Sample', MaskedInputWorkspace='mask',
+ OutputWorkspace='sample_with_flux', FluxInputWorkspace='fl', ReferenceInputWorkspace='water_with_flux')
+
+ # Reduce sample without flux normalisation and not flux normalised water reference
+ SANSILLReduction(Run='010569', ProcessAs='Sample', MaskedInputWorkspace='mask',
+ OutputWorkspace='sample_wo_flux', ReferenceInputWorkspace='water_wo_flux')
+
+ # Now the sample_with_flux and sample_wo_flux should be approximately at the same scale
+ result1, _ = CompareWorkspaces(Workspace1='sample_with_flux', Workspace2='sample_wo_flux', Tolerance=0.1)
+ self.assertTrue(result1)
+
+ # Then we want to simulate the situation where water has no flux measurement
+ # Reduce water, but normalise it to the sample flux (water will get scaled here)
+ SANSILLReduction(Run='010453', ProcessAs='Sample', MaskedInputWorkspace='mask',
+ OutputWorkspace='water_with_sample_flux', FluxInputWorkspace='fl')
+
+ # Reduce sample with flux normalisation and sample flux normalised water reference
+ # Here there is no additional scaling, since both are already normalised
+ SANSILLReduction(Run='010569', ProcessAs='Sample', MaskedInputWorkspace='mask',
+ OutputWorkspace='sample_with_flux_water_with_sample_flux',
+ FluxInputWorkspace='fl', ReferenceInputWorkspace='water_with_sample_flux')
+
+ # Now this output should still be at the same scale as the two above
+ # (basically it is the same scaling, just happening in different place)
+ result2, _ = CompareWorkspaces(Workspace1='sample_with_flux_water_with_sample_flux',
+ Workspace2='sample_wo_flux', Tolerance=0.1)
+ self.assertTrue(result2)
+
+ result3, _ = CompareWorkspaces(Workspace1='sample_with_flux_water_with_sample_flux',
+ Workspace2='sample_with_flux', Tolerance=0.1)
+ self.assertTrue(result3)
+
+ # Finally we want to make sure that trying to divide flux normalised sample by
+ # non flux normalised water raises an error
+ kwargs = {
+ 'Run' : '010569',
+ 'ProcessAs' : 'Sample',
+ 'MaskedInputWorkspace' : 'mask',
+ 'OutputWorkspace' : 'sample_with_flux_water_wo_flux',
+ 'FluxInputWorkspace' : 'fl',
+ 'ReferenceInputWorkspace' : 'water_wo_flux'
+ }
+ self.assertRaises(RuntimeError, SANSILLReduction, **kwargs)
diff --git a/Testing/SystemTests/tests/analysis/SANSILLReductionTest.py b/Testing/SystemTests/tests/analysis/SANSILLReductionTest.py
index da6b2fac4a691d5944a37b3535630f952d69737a..583a9ad25c310928c1aa98141e0f303ad56abb5f 100644
--- a/Testing/SystemTests/tests/analysis/SANSILLReductionTest.py
+++ b/Testing/SystemTests/tests/analysis/SANSILLReductionTest.py
@@ -299,60 +299,3 @@ class ILL_D33_Test(systemtesting.MantidSystemTest):
# I(Q)
SANSILLIntegration(InputWorkspace='sample_flux', OutputWorkspace='iq')
-
-
-class ILL_D11_AbsoluteScale_Test(systemtesting.MantidSystemTest):
-
- def __init__(self):
- super(ILL_D11_AbsoluteScale_Test, self).__init__()
- self.setUp()
-
- def setUp(self):
- config['default.facility'] = 'ILL'
- config['default.instrument'] = 'D11'
- config.appendDataSearchSubDir('ILL/D11/')
-
- def cleanup(self):
- mtd.clear()
-
- def validate(self):
- self.tolerance = 1e-5
- self.tolerance_is_rel_err = True
- self.disableChecking = ['Instrument']
- return ['abs_scale_outputs', 'D11_AbsScaleReference.nxs']
-
- def runTest(self):
- # Load the mask
- LoadNexusProcessed(Filename='D11_mask.nxs', OutputWorkspace='mask')
-
- # Process the dark current Cd/B4C for water
- SANSILLReduction(Run='010455', ProcessAs='Absorber', OutputWorkspace='Cdw')
-
- # Process the empty beam for water
- SANSILLReduction(Run='010414', ProcessAs='Beam', AbsorberInputWorkspace='Cdw', OutputWorkspace='Dbw',
- FluxOutputWorkspace='Flw')
- # Water container transmission
- SANSILLReduction(Run='010446', ProcessAs='Transmission', AbsorberInputWorkspace='Cdw',
- BeamInputWorkspace='Dbw', OutputWorkspace='wc_tr')
- # Water container
- SANSILLReduction(Run='010454', ProcessAs='Container', AbsorberInputWorkspace='Cdw',
- BeamInputWorkspace='Dbw', TransmissionInputWorkspace='wc_tr', OutputWorkspace='wc')
- # Water transmission
- SANSILLReduction(Run='010445', ProcessAs='Transmission', AbsorberInputWorkspace='Cdw',
- BeamInputWorkspace='Dbw', OutputWorkspace='w_tr')
- # Water as reference
- SANSILLReduction(Run='010453', ProcessAs='Sample', AbsorberInputWorkspace='Cdw', MaskedInputWorkspace='mask',
- ContainerInputWorkspace='wc', BeamInputWorkspace='Dbw', TransmissionInputWorkspace='wc_tr',
- SensitivityOutputWorkspace='sens', OutputWorkspace='reference', FluxInputWorkspace='Flw')
- # Water as sample with sensitivity and flux
- SANSILLReduction(Run='010453', ProcessAs='Sample', AbsorberInputWorkspace='Cdw', MaskedInputWorkspace='mask',
- ContainerInputWorkspace='wc', BeamInputWorkspace='Dbw', TransmissionInputWorkspace='wc_tr',
- SensitivityInputWorkspace='sens', OutputWorkspace='water_with_sens_flux', FluxInputWorkspace='Flw')
- # Water with itself as reference and flux
- SANSILLReduction(Run='010453', ProcessAs='Sample', AbsorberInputWorkspace='Cdw', MaskedInputWorkspace='mask',
- ContainerInputWorkspace='wc', BeamInputWorkspace='Dbw', TransmissionInputWorkspace='wc_tr',
- ReferenceInputWorkspace='reference', OutputWorkspace='water_with_reference', FluxInputWorkspace='Flw')
-
- # Group the worksaces
- GroupWorkspaces(InputWorkspaces=['sens', 'reference', 'water_with_reference', 'water_with_sens_flux'],
- OutputWorkspace='abs_scale_outputs')
diff --git a/Testing/SystemTests/tests/analysis/SANSLoadTest.py b/Testing/SystemTests/tests/analysis/SANSLoadTest.py
index 4ed7a0ccef866806f47f7ae7338f6276fc603f13..eb17dc8fc14152a097527110fe37475a0c1311a8 100644
--- a/Testing/SystemTests/tests/analysis/SANSLoadTest.py
+++ b/Testing/SystemTests/tests/analysis/SANSLoadTest.py
@@ -23,7 +23,7 @@ from sans.common.constants import (CALIBRATION_WORKSPACE_TAG, SANS_FILE_TAG)
from sans.state.Serializer import Serializer
from sans.test_helper.test_director import TestDirector
from sans.common.enums import SANSFacility
-from sans.state.data import get_data_builder
+from sans.state.StateObjects.StateData import get_data_builder
from sans.common.file_information import SANSFileInformationFactory
diff --git a/Testing/SystemTests/tests/analysis/SANSMergedDetectorsTest.py b/Testing/SystemTests/tests/analysis/SANSMergedDetectorsTest.py
index c9f32a04d081870647068db415ad652dfd86bd42..72e41cc7f01d9655d3a40742f208ad8ed9851394 100644
--- a/Testing/SystemTests/tests/analysis/SANSMergedDetectorsTest.py
+++ b/Testing/SystemTests/tests/analysis/SANSMergedDetectorsTest.py
@@ -7,7 +7,7 @@
#pylint: disable=invalid-name
from __future__ import (absolute_import, division, print_function)
-from mantid.simpleapi import *
+from mantid.simpleapi import DeleteWorkspace, mtd
import ISISCommandInterface as i
import systemtesting
diff --git a/Testing/SystemTests/tests/analysis/SANSReductionCoreTest.py b/Testing/SystemTests/tests/analysis/SANSReductionCoreTest.py
index bc10d87cfe452a438115935aa977db7bd4492f78..01ed460e327f9f588ed6a16aa88525ce2c358775 100644
--- a/Testing/SystemTests/tests/analysis/SANSReductionCoreTest.py
+++ b/Testing/SystemTests/tests/analysis/SANSReductionCoreTest.py
@@ -14,10 +14,11 @@ import systemtesting
import mantid
from mantid.api import AlgorithmManager
from sans.state.Serializer import Serializer
+from sans.state.StateBuilder import StateBuilder
-from sans.state.data import get_data_builder
+from sans.state.StateObjects.StateData import get_data_builder
from sans.common.enums import (DetectorType, DataType, SANSFacility)
-from sans.user_file.state_director import StateDirectorISIS
+
from sans.common.constants import EMPTY_NAME
from sans.common.general_functions import create_unmanaged_algorithm
from sans.common.file_information import SANSFileInformationFactory
@@ -151,21 +152,13 @@ class SANSReductionCoreTest(unittest.TestCase):
data_state = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_state, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
-
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # Since we are dealing with event based data but we want to compare it with histogram data from the
- # old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
- # Construct the final state
- state = user_file_director.construct()
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_state,
+ user_filename=user_file)
+ state = user_file_director.get_all_states()
+
+ state.compatibility.use_compatibility_mode = True
# Load the sample workspaces
workspace, workspace_monitor, transmission_workspace, direct_workspace = self._load_workspace(state)
@@ -202,13 +195,13 @@ class SANSReductionCoreTest(unittest.TestCase):
# Compatibility mode
################################################################################################################
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_state, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
-
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_state,
+ user_filename=user_file)
- # Construct the final state
- state = user_file_director.construct()
+ state = user_file_director.get_all_states()
+ state.compatibility.use_compatibility_mode = True
# Load the sample workspaces
workspace, workspace_monitor, transmission_workspace, direct_workspace = self._load_workspace(state)
@@ -221,13 +214,12 @@ class SANSReductionCoreTest(unittest.TestCase):
################################################################################################################
# Non-compatibility mode
################################################################################################################
- user_file_director = StateDirectorISIS(data_state, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
-
- user_file_director.set_compatibility_builder_use_compatibility_mode(False)
-
- # Construct the final state
- state = user_file_director.construct()
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_state,
+ user_filename=user_file)
+ state = user_file_director.get_all_states()
+ state.compatibility.use_compatibility_mode = False
# Load the sample workspaces
workspace, workspace_monitor, transmission_workspace, direct_workspace = self._load_workspace(state)
diff --git a/Testing/SystemTests/tests/analysis/SANSSingleReductionTest.py b/Testing/SystemTests/tests/analysis/SANSSingleReductionTest.py
index eaf4273e917f2301c7d3352855aa247623c07b91..435c68bc87041cab1799069cb87b0bc891b395e5 100644
--- a/Testing/SystemTests/tests/analysis/SANSSingleReductionTest.py
+++ b/Testing/SystemTests/tests/analysis/SANSSingleReductionTest.py
@@ -8,23 +8,25 @@
from __future__ import (absolute_import, division, print_function)
-import systemtesting
import unittest
-import mantid # noqa
+import systemtesting
+
from mantid.api import AlgorithmManager
-from sans.state.Serializer import Serializer
-from sans.user_file.state_director import StateDirectorISIS
-from sans.state.data import get_data_builder
-from sans.common.enums import (SANSFacility, ReductionMode, ReductionDimensionality, FitModeForMerge)
from sans.common.constants import EMPTY_NAME
-from sans.common.general_functions import create_unmanaged_algorithm
+from sans.common.enums import (SANSFacility, ReductionMode, ReductionDimensionality, FitModeForMerge)
from sans.common.file_information import SANSFileInformationFactory
+from sans.common.general_functions import create_unmanaged_algorithm
+from sans.state.Serializer import Serializer
+from sans.state.StateBuilder import StateBuilder
+from sans.state.StateObjects.StateData import get_data_builder
# ----------------------------------------------------------------------------------------------------------------------
# Base class containing useful functions for the tests
# ----------------------------------------------------------------------------------------------------------------------
+
+
class SingleReductionTest(unittest.TestCase):
def _load_workspace(self, state):
load_alg = AlgorithmManager.createUnmanaged("SANSLoad")
@@ -160,21 +162,18 @@ class SANSSingleReductionTest(SingleReductionTest):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_file)
+
+ state = user_file_director.get_all_states()
# Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.LAB)
+ state.reduction.reduction_mode = ReductionMode.LAB
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
# Since we are dealing with event based data but we want to compare it with histogram data from the
# old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- state = user_file_director.construct()
+ state.compatibility.use_compatibility_mode = True
# Load the sample workspaces
sample, sample_monitor, transmission_workspace, direct_workspace, can, can_monitor, \
@@ -229,21 +228,13 @@ class SANSSingleReductionTest(SingleReductionTest):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
- # Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.HAB)
-
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # Since we are dealing with event based data but we want to compare it with histogram data from the
- # old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- state = user_file_director.construct()
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_file)
+ state = user_file_director.get_all_states()
+ state.reduction.reduction_mode = ReductionMode.HAB
+ state.compatibility.use_compatibility_mode = True
# Load the sample workspaces
sample, sample_monitor, transmission_workspace, direct_workspace, can, can_monitor,\
@@ -283,23 +274,18 @@ class SANSSingleReductionTest(SingleReductionTest):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
- # Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.MERGED)
- user_file_director.set_reduction_builder_merge_fit_mode(FitModeForMerge.BOTH)
- user_file_director.set_reduction_builder_merge_scale(1.0)
- user_file_director.set_reduction_builder_merge_shift(0.0)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # Since we are dealing with event based data but we want to compare it with histogram data from the
- # old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- state = user_file_director.construct()
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_file)
+
+ state = user_file_director.get_all_states()
+ state.reduction.reduction_mode = ReductionMode.MERGED
+ state.reduction.merge_fit_mode = FitModeForMerge.BOTH
+ state.reduction.merge_scale = 1.0
+ state.reduction.merge_shift = 0.0
+
+ state.compatibility.use_compatibility_mode = True
# Load the sample workspaces
sample, sample_monitor, transmission_workspace, direct_workspace, \
@@ -348,22 +334,19 @@ class SANSSingleReductionTest(SingleReductionTest):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_file)
+
+ state = user_file_director.get_all_states()
+
# Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.LAB)
- user_file_director.set_reduction_builder_reduction_dimensionality(ReductionDimensionality.TWO_DIM)
- user_file_director.set_convert_to_q_builder_reduction_dimensionality(ReductionDimensionality.TWO_DIM)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY BEGIN -- Remove when appropriate
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # Since we are dealing with event based data but we want to compare it with histogram data from the
- # old reduction system we need to enable the compatibility mode
- user_file_director.set_compatibility_builder_use_compatibility_mode(True)
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- # COMPATIBILITY END
- # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- state = user_file_director.construct()
+ state.reduction.reduction_mode = ReductionMode.LAB
+ state.reduction.reduction_dimensionality = ReductionDimensionality.TWO_DIM
+ state.convert_to_q.reduction_dimensionality = ReductionDimensionality.TWO_DIM
+
+ state.compatibility.use_compatibility_mode = True
# Load the sample workspaces
sample, sample_monitor, transmission_workspace, direct_workspace, can, can_monitor, \
@@ -415,18 +398,18 @@ class SANSSingleReduction2Test(SingleReductionTest):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_file)
+ state = user_file_director.get_all_states()
# Set the reduction mode to HAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.HAB)
- user_file_director.set_compatibility_builder_use_compatibility_mode(False)
+ state.reduction.reduction_mode = ReductionMode.HAB
+ state.compatibility.use_compatibility_mode = False
# Add some event slices
- user_file_director.set_slice_event_builder_start_time([0.00, 300.00])
- user_file_director.set_slice_event_builder_end_time([300.00, 600.00])
-
- # Construct
- state = user_file_director.construct()
+ state.slice.start_time = [0.00, 300.00]
+ state.slice.end_time = [300.00, 600.00]
# Load the sample workspaces
sample, sample_monitor, transmission_workspace, direct_workspace, can, can_monitor,\
@@ -466,9 +449,8 @@ class SANSSingleReduction2Test(SingleReductionTest):
# ---------------------------------------------------
# Run the first event slice
- user_file_director.set_slice_event_builder_start_time([0.00])
- user_file_director.set_slice_event_builder_end_time([300.00])
- state = user_file_director.construct()
+ state.slice.start_time = [0.00]
+ state.slice.end_time = [300.00]
single_reduction_alg_first_slice = self._run_single_reduction(state, sample_scatter=sample,
sample_transmission=transmission_workspace,
@@ -483,9 +465,8 @@ class SANSSingleReduction2Test(SingleReductionTest):
save_can=True)
# Run the second event slice
- user_file_director.set_slice_event_builder_start_time([300.00])
- user_file_director.set_slice_event_builder_end_time([600.00])
- state = user_file_director.construct()
+ state.slice.start_time = [300.00]
+ state.slice.end_time = [600.00]
single_reduction_alg_second_slice = self._run_single_reduction(state, sample_scatter=sample,
sample_transmission=transmission_workspace,
@@ -540,18 +521,18 @@ class SANSSingleReduction2Test(SingleReductionTest):
data_info = data_builder.build()
# Get the rest of the state from the user file
- user_file_director = StateDirectorISIS(data_info, file_information)
- user_file_director.set_user_file("USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt")
+ user_file = "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger.txt"
+ user_file_director = StateBuilder.new_instance(file_information=file_information,
+ data_information=data_info,
+ user_filename=user_file)
# Set the reduction mode to LAB
- user_file_director.set_reduction_builder_reduction_mode(ReductionMode.LAB)
- user_file_director.set_compatibility_builder_use_compatibility_mode(False)
+ state = user_file_director.get_all_states()
+ state.reduction.reduction_mode = ReductionMode.LAB
+ state.compatibility.use_compatibility_mode = False
# Add some event slices
- user_file_director.set_slice_event_builder_start_time([0.00, 300.00])
- user_file_director.set_slice_event_builder_end_time([300.00, 600.00])
-
- # Construct
- state = user_file_director.construct()
+ state.slice.start_time = [0.00, 300.00]
+ state.slice.end_time = [300.00, 600.00]
# Load the sample workspaces
sample, sample_monitor, transmission_workspace, direct_workspace, can, can_monitor,\
@@ -590,9 +571,8 @@ class SANSSingleReduction2Test(SingleReductionTest):
# This can be removed once version 2 has been adopted
# ---------------------------------------------------
# Run the first event slice
- user_file_director.set_slice_event_builder_start_time([0.00])
- user_file_director.set_slice_event_builder_end_time([300.00])
- state = user_file_director.construct()
+ state.slice.start_time = [0.00]
+ state.slice.end_time = [300.00]
single_reduction_alg_first_slice = self._run_single_reduction(state, sample_scatter=sample,
sample_transmission=transmission_workspace,
@@ -607,9 +587,8 @@ class SANSSingleReduction2Test(SingleReductionTest):
save_can=True)
# Run the second event slice
- user_file_director.set_slice_event_builder_start_time([300.00])
- user_file_director.set_slice_event_builder_end_time([600.00])
- state = user_file_director.construct()
+ state.slice.start_time = [300.00]
+ state.slice.end_time = [600.00]
single_reduction_alg_second_slice = self._run_single_reduction(state, sample_scatter=sample,
sample_transmission=transmission_workspace,
diff --git a/Testing/SystemTests/tests/analysis/reference/D11_AbsScaleReference.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/D11_AbsScaleReference.nxs.md5
index 258b1b7bb25616c465b9ca505a37365cc9905182..f54a61cae4374f993ab9b8de842bd951b9026a85 100644
--- a/Testing/SystemTests/tests/analysis/reference/D11_AbsScaleReference.nxs.md5
+++ b/Testing/SystemTests/tests/analysis/reference/D11_AbsScaleReference.nxs.md5
@@ -1 +1 @@
-37ca323c47478b6c49b26676a89423a8
+8d9ed6b7ed46d696b8f81b754d7c7ae7
diff --git a/Testing/SystemTests/tests/analysis/reference/ILLIN16B_BATS.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/ILLIN16B_BATS.nxs.md5
index 718356cf226621f1d0840e96ac3f5f9e8d1d6666..0909b435608e7e3346efc585e51ca59a7c6be0c5 100644
--- a/Testing/SystemTests/tests/analysis/reference/ILLIN16B_BATS.nxs.md5
+++ b/Testing/SystemTests/tests/analysis/reference/ILLIN16B_BATS.nxs.md5
@@ -1 +1 @@
-37a012a21d704bfcee5939cdb4079f70
+8642ede143339ef72be12fd30389cf6a
diff --git a/Testing/SystemTests/tests/analysis/reference/ILLIN16B_QENS.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/ILLIN16B_QENS.nxs.md5
index d4d94ab5f7161402be0baf2f86bcf95ee7ffd733..638c9efa4b7c4033d08f0090ceebf7aef7253af0 100644
--- a/Testing/SystemTests/tests/analysis/reference/ILLIN16B_QENS.nxs.md5
+++ b/Testing/SystemTests/tests/analysis/reference/ILLIN16B_QENS.nxs.md5
@@ -1 +1 @@
-17146cd3b56813c82e896b7b427014cd
+5e7a733b977fbd56354432ed07e2daac
diff --git a/Testing/SystemTests/tests/analysis/reference/ILL_SANS_D11_IQ.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/ILL_SANS_D11_IQ.nxs.md5
index 1f96700f48694130dc8b90efbd3dee957681e77c..93a9a998fed31d215d4a42f6f6272a1e9a8a49c4 100644
--- a/Testing/SystemTests/tests/analysis/reference/ILL_SANS_D11_IQ.nxs.md5
+++ b/Testing/SystemTests/tests/analysis/reference/ILL_SANS_D11_IQ.nxs.md5
@@ -1 +1 @@
-cd7c39ac8e064f4a639155f3e747c832
+036c8504fc9d7f68be0f8f42c8a64e8e
diff --git a/Testing/SystemTests/tests/analysis/reference/ISISReflectometryReducedRunsResult.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/ISISReflectometryReducedRunsResult.nxs.md5
index 224426b6ad5bd56e0275702df0cf67ce1615fa8d..c149241ceb11a1310f4a0ae441f51408c064333a 100644
--- a/Testing/SystemTests/tests/analysis/reference/ISISReflectometryReducedRunsResult.nxs.md5
+++ b/Testing/SystemTests/tests/analysis/reference/ISISReflectometryReducedRunsResult.nxs.md5
@@ -1 +1 @@
-050d866089735a3107558c0effcfaae3
+1c6babfa2dce0bede17fa6961a8849f8
diff --git a/Testing/SystemTests/tests/analysis/reference/ISISReflectometryWorkflowSlicingResult.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/ISISReflectometryWorkflowSlicingResult.nxs.md5
index 4d67650e5224e0e406c25148e83bc47c078b6ce5..949b665da7b16126ed3c12f0cd498b2fcb7687d0 100644
--- a/Testing/SystemTests/tests/analysis/reference/ISISReflectometryWorkflowSlicingResult.nxs.md5
+++ b/Testing/SystemTests/tests/analysis/reference/ISISReflectometryWorkflowSlicingResult.nxs.md5
@@ -1 +1 @@
-6749ec6060b1e697e77ad29c9dc2ce4a
+d0b509de975d822199aff59d8c3f8599
diff --git a/dev-docs/source/ISISSANSReductionBackend.rst b/dev-docs/source/ISISSANSReductionBackend.rst
index 4df10a40583bced8f7269ebe8d4fb4aed1a616d0..07d92528c35023b19d2e4cf16c1ec9a6463da75f 100644
--- a/dev-docs/source/ISISSANSReductionBackend.rst
+++ b/dev-docs/source/ISISSANSReductionBackend.rst
@@ -333,13 +333,13 @@ beam_stop_arm_pos1 The x position of the beam stop arm
beam_stop_arm_pos2 The y position of the beam stop arm *FloatParameter* Y N
clear currently not used *BoolParameter* Y N
clear_time currently not used *BoolParameter* Y N
-detector A dict of detector type to *StateMaskDetector* sub-states *DictParameter* N Y
+detector A dict of detector type to *StateMaskDetectors* sub-states *DictParameter* N Y
idf_path The path to the IDF *StringParameter* N Y
====================== ========================================================== ========================= ========= ===============
Validation is applied to some of the entries.
-The detector-specific settings are stored in the *StateMaskDetector* which contains the following parameters:
+The detector-specific settings are stored in the *StateMaskDetectors* which contains the following parameters:
============================ ============ =============================== ========= ===============
Name Comment Type Optional? Auto-generated?
diff --git a/dev-docs/source/ReleaseChecklist.rst b/dev-docs/source/ReleaseChecklist.rst
index ff4edc22396ce0f1e7832ba748452ed6e2d205af..8c7d6b2cc9950310bf1855b0f9b4362ad765e66b 100644
--- a/dev-docs/source/ReleaseChecklist.rst
+++ b/dev-docs/source/ReleaseChecklist.rst
@@ -67,11 +67,8 @@ Unscripted and Final Testing (technical tasks)
* Run
`open-release-testing <http://builds.mantidproject.org/view/All/job/open-release-testing/>`__
to create the release branch and prepare build jobs
-* Enable and update the release branch name for
- `merge\_release\_into\_master <http://builds.mantidproject.org/view/All/job/merge_release_into_master/>`__
-* Check state of all open pull requests for this milestone and update
- the base branch to the new release branch accordingly.
-* Create a skeleton set of release notes for the next version using the `python helper tool <https://github.com/mantidproject/mantid/blob/master/tools/release_generator/release.py>`_
+* Check state of all open pull requests for this milestone and decide which should be kept for the release, liase with PM on this. Move any pull requests not targeted for release out of the milestone and run `update-pr-base-branch.py <https://github.com/mantidproject/mantid/blob/master/tools/scripts/update-pr-base-branch.py>`__ to update the base branches of those pull requests.
+* Create a skeleton set of release notes for the next version using the `python helper tool <https://github.com/mantidproject/mantid/blob/master/tools/release_generator/release.py>`_ and open a pull request to put them on ``master``.
* Perform unscripted testing following the instructions described
`here <https://www.mantidproject.org/Unscripted_Manual_Testing>`__.
diff --git a/dev-docs/source/Testing/Engineering Diffraction Test Guide.rst b/dev-docs/source/Testing/Engineering Diffraction Test Guide.rst
deleted file mode 100644
index 261a0717b72af9994dd94d2f4c5b06e4941facd1..0000000000000000000000000000000000000000
--- a/dev-docs/source/Testing/Engineering Diffraction Test Guide.rst
+++ /dev/null
@@ -1,220 +0,0 @@
-.. _Engineering_Diffraction_TestGuide-ref:
-
-Engineering Diffraction Testing
-=================================
-
-.. contents:: Table of Contents
- :local:
-
-Preamble
-^^^^^^^^^
-This document is tailored towards developers intending to test the Engineering Diffraction
-interface.
-
-The files used in the following examples are found within System test files within
-`<MantidBuildDir>/ExternalData/Testing/Data/SystemTest` after building the *SystemTestData* target.
-Runs can also be loaded from the archive, however different run numbers will be needed as older runs may
-be deleted.
-
-Overview
-^^^^^^^^
-The Engineering Diffraction interface allows scientists using the EnginX instrument to interactively
-process their data. There are 5 tabs from which are ordered according to the main steps performed.
-These are:
-
-- Calibration - This is where a vanadium and cerium run are entered to calibrate the subsequent data.
-- Focus - Where are the data across multiple spectra are summed into a single spectrum for later steps.
-- Pre-processing - Event workspaces have to be converted into histogram data before
- focusing which can be completed here.
-- Fitting - The user uses their focused data here to interactively pick peaks for subsequent fitting.
-- Settings - This holds additional settings which may be of use during testing.
-
-.. _calibration-Engineering_Diffraction_test-ref:
-
-Calibration
-^^^^^^^^^^^
-The first time the interface is opened it will be disabled except for the RB number entry box
-and a pop up box which should prompt for a RB number. For testing purposes this can be anything.
-
-If a vanadium calibration has never been run the `Current calibration` will be empty. Once
-a calibration has been run these fields will retain their values for future runs of the program.
-The following files can be used for the calibration run.
-
-- *Vanadium#*: ENGINX00236516.nxs / 307521 for archive
-
-- *Calibration#*: ENGINX00241391.nxs / 305738 for archive
-
-Once the calibration has completed if the calibration was successful plotting the spectra of the
-newly created workspaces will produce images similar to below:
-
-.. image:: /images/EngineeringDiffractionTest/EnggDiffExpectedVanCurve.png
- :width: 300px
-.. image:: /images/EngineeringDiffractionTest/EnggDiffExpectedLinear.png
- :width: 300px
-
-If the plot is incorrect check you haven't swapped the run numbers and they are both correct.
-
-If `Current calibration` is populated the algorithm will attempt to use a cached calculation instead
-of recalculating the calibration. To force it to recalculate every time for testing purposes the
-option can be set under the Engineering Diffraction Settings.
-
-A cropped calibration can be used to limit the spectra considered during calibration. This can
-be useful if a subset of detectors are going to be used.
-
-Negative Testing Ideas
-----------------------
-
-- Change the RB number (or remove it) and try immediately using controls such as close
-
-- Running calibrate with various fields left blank
-
-- Using files which aren't calibration files \- Mantid shouldn't crash
-
-.. _focus-Engineering_Diffraction_test-ref:
-
-Focus
-^^^^^
-Focusing takes a workspace with histogram data and sums the spectra into a single spectrum.
-If the data is captured in event mode (i.e.. Event workspaces) it will first
-need :ref:`preProcessing-Engineering_Diffraction_test-ref` .
-
-A .nxs file containing histogram data needs to be selected for example *ENGINX00193749.nxs*
-/ 305761 on archive. This can have all banks summed, specific spectra and list or use a
-detector grouping to create a texture.
-
-Once the focus run has finished it will save a focused .nxs file in
-
-`C:\\EnginX_Mantid\\User\\<RB Number>` or `~/EnginX_Mantid/User/<RB Number>`
-
-and store a copy in `C:\\EnginX_Mantid\\Focus` or `~/EnginX_Mantid/Focus`.
-
-The saved focused .nxs filename will be of the format
-`<INST>_<Run number>_focused_bank_<bank number>.nxs`
-
-Plotting the focused workspace should look similar to the image below:
-
-.. image:: /images/EngineeringDiffractionTest/EnggDiffExampleFocusOutput.png
- :width: 300px
-
-Negative Testing Ideas
-----------------------
-
-- Using a .nxs file which doesn't have expected data \- Mantid shouldn't crash
-
-- Running focus with no banks selected
-
-- Using Cropped/Texture with bad inputs
-
-- Whilst the data is being focused only `Plot Data Representation` should be changeable
-
-
-.. _preProcessing-Engineering_Diffraction_test-ref:
-
-Pre-processing
-^^^^^^^^^^^^^^
-Pre-processing is used to convert event data into histogram data which can be subsequently
-focused. The optimal parameters for pre-processing are dependent on how the instrument was
-configured during the capture of the data.
-
-`Regular time binning` requires the bin width to be specified and will produce a histogram #
-workspace with TOF as the X axis.
-
-If the multi-period data with pulse times is captured `Multi-period data` should be used instead
-with the delta in time on every step of the X axis entered.
-
-For testing purposes with regular time binning testing should be done using 305761 on archive,
-multi-period data should instead use a run from 285643-285701 which are event workspaces.
-
-Fitting
-^^^^^^^
-Fitting allows a user to plot the peaks from their focused nexus file obtained from
-:ref:`focus-Engineering_Diffraction_test-ref` . The focused run can be entered by value
-`193749`, a range of runs `19000-19100` or by browsing for the focused file.
-
-After the fitting has run if it managed to fit any peaks it should look similar to below
-if there are no peaks and the display looks "corrupted" check the calibration was completed
-correctly:
-
-.. image:: /images/EngineeringDiffractionTest/EnggDiffExampleFitOutput.png
- :width: 500px
-
-The banks available to plot are selected with the `Plot Bank` selector and then fit is clicked.
-Mantid will plot the peaks in the peak picker window, expected peaks can also be selected
-to help the fitting process. Zoom in by dragging with the LMB and out by clicking the RMB.
-Peaks are selected by holding `Shift` whilst clicking the LMB on a peak similar to the fit interface.
-
-Once peaks are selected fit can be re-run with the expected peak list specified to attempt to
-create a better fitting.
-
-Negative Testing Ideas
-----------------------
-- Using an unfocused .nxs file \- Mantid shouldn't crash
-
-- Enter an unusual file name combinations such as `ENGINX_1000-2000` which combines a filename and
- multi run number
-
-- Enter bad input to expected peaks
-
-- Change any unlocked dialog boxes whilst `Fit` runs
-
-
-.. _gsas-fitting-Engineering-Diffraction_test-ref:
-
-GSAS Fitting
-^^^^^^^^^^^^
-
-GSAS-style fitting allows the user to plot peaks from their focused
-NeXuS file (obtained from
-:ref:`focus-Engineering_Diffraction_test-ref`).
-
-After a fit has run, the plot should look something like below:
-
-.. image:: /images/EngineeringDiffractionTest/EnggDiffExampleGSASOutput.png
-
-If that fit output (the red line) is flat, or just follows the
-background of the data, the fit was not unsuccessful. Make sure you're
-using the right ``.cif`` and ``.prm`` files for your run. You can find
-an example of files which work nicely together on most PRs related to
-the GSAS tab or GSASIIRefineFitPeaks, or have a look `here
-<https://github.com/mantidproject/mantid/files/1739753/GSASIIRefineFitPeaks.zip>`_.
-
-.. warning:: At the moment, you will also just get background if you
- try to do a Pawley refinement, as this is still under
- development, possibly requiring input from ENGINX
- scientists or GSAS-II developers (probably both)
-
-You can navigate around the plot in the same way as the Fitting tab.
-
-Negative Testing Ideas
-----------------------
-
-- Using an unfocused .nxs file \- Mantid shouldn't crash
-- Enter bad input into the text entries - this should be handled
- elegantly
-- Change any unlocked dialogs and click any unlocked buttons while
- refinement is running
-- Cancel the algorithm before exiting the GUI, and vice verse
-
-.. _settings-Engineering_Diffraction_test-ref:
-
-Settings
-^^^^^^^^^
-- `Input directories/folders`
- Used as additional search locations when only a run number
- is specified such as `193749`. These do not need to be set for the browse (full paths) to work.
-
-- `Pixel Calibration`
- Is used for a full calibration run. Before each run they perform a quick
- calibration which is accounted for in the :ref:`calibration-Engineering_Diffraction_test-ref` tab.
- Every couple of years they perform a long calibration which is then processed and used as a baseline
- which is set here.
-
-- `Force recalculate`
- Useful whilst troubleshooting calibrations if you think a cached calibration
- is incorrect or you are testing the calibration algorithm. However this incurs a significant speed
- penalty as calibration is run every time instead of just reusing the results.
-
-- `Focusing settings`
- Allows the user to specify the output directory of their own focused runs
- it defaults to `C:\\EnginX_Mantid\\Focus` or `~/EnginX_Mantid/Focus` but can be changed to
- suit the users needs.
diff --git a/dev-docs/source/Testing/EngineeringDiffraction/EngineeringDiffraction2TestGuide.rst b/dev-docs/source/Testing/EngineeringDiffraction/EngineeringDiffraction2TestGuide.rst
new file mode 100644
index 0000000000000000000000000000000000000000..2f53943d636acbff5b2e08de6ff5c058a61d5b1f
--- /dev/null
+++ b/dev-docs/source/Testing/EngineeringDiffraction/EngineeringDiffraction2TestGuide.rst
@@ -0,0 +1,114 @@
+.. _Engineering_Diffraction_2_TestGuide-ref:
+
+Engineering Diffraction 2 Testing
+=================================
+
+.. contents:: Table of Contents
+ :local:
+
+Preamble
+^^^^^^^^^
+This document is tailored towards developers intending to test the Engineering Diffraction
+interface 2.
+
+Runs can be loaded from the archive, however it is possible that different run numbers
+will be needed as older runs may be deleted.
+
+Overview
+^^^^^^^^
+The Engineering Diffraction 2 interface allows scientists using the EnginX instrument to interactively
+process their data. There are 3 tabs which are ordered according to the main steps performed.
+These are:
+
+- Calibration - This is where a vanadium and cerium oxide run are entered to calibrate the subsequent data.
+- Focus - Where are the data across multiple spectra are summed into a single spectrum for later steps.
+- Fitting - Currently a work in progress, no testing is required
+
+Test 1
+^^^^^^
+This test follows the simple steps for calibrating and focusing in the Engineering Diffraction 2 Gui.
+
+Calibration
+-----------
+
+1. Ensure you are able to access the archive.
+
+2. Open the Engineering Diffraction 2 gui.
+
+3. On opening the gui the Create New Calibration option should be selected.
+
+4. Open the setting dialog from the cog in the bottom left of the gui.
+
+5. Set the Save location to a directory of your choice.
+
+6. For the vanadium number enter `307521`, and for the Calibration Sample number enter `305738`.
+
+7. Tick the Plot Calibrated Workspace option.
+
+8. Click Calibrate, after completing calibration it should produce two plots.
+
+.. image:: /images/EngineeringDiffractionTest/EnggDiffExpectedVanCurve.png
+ :width: 900px
+
+.. image:: /images/EngineeringDiffractionTest/EnggDiffExpectedLinear.png
+ :width: 900px
+
+9. Check that in your save location there is a Calibration folder containing three files
+ `ENGINX_307521_305738` with the suffixes `_all_bank`, `_bank_North`, `_bank_South`, and
+ a Vanadium_Runs folder containing two files: `307521_precalculated_vanadium_run_bank_curves`
+ and `307521_precalculated_vanadium_run_integration`.
+
+Focus
+-----
+
+1. Change to the Focus tab.
+
+2. For the Sample Run number use `305761`.
+
+3. Tick the Plot Focused Workspace option.
+
+4. Click Focus, after completing calibration it should produce a plot.
+
+.. image:: /images/EngineeringDiffractionTest/EnggDiffExampleFocusOutput.png
+ :width: 900px
+
+5. Check that in your save location there is a Calibration folder containing six files
+ `ENGINX_305761_bank_1` and `ENGINX_305761_bank_2` for each of `.dat`, `.gss`, and `.nxs`.
+
+Test 2
+^^^^^^
+
+This test covers the RB number.
+
+1. Enter a string into the RB number box.
+
+2. Follow the steps of Test 1, any output files should now be located in [Save location]/user/[RB number]
+
+Test 3
+^^^^^^
+
+This test covers the Force Vanadium Recalculation functionality.
+
+1. With the previous setup run calibration again. It should happen much faster as it loads
+ the previous calibration.
+
+2. In the Engineering Diffraction 2 settings tick the Force Vanadium Recalculation.
+
+3. Calibrate again. It should take a longer time to perform as it does the entire calibration again.
+
+Test 4
+^^^^^^
+
+This test covers the Cropping ability
+
+1. Change the RB Number to North.
+
+2. Tick the Crop Calibration option. In the select Bank/Spectra select `1 (North)`
+
+3. Click calibrate.
+
+4. Go to focus tab and do the same with the Crop Focus.
+
+5. Change the RB number to custom.
+
+6. Repeat steps 2-4 this time using Custom Spectra `1200-1400`
\ No newline at end of file
diff --git a/dev-docs/source/Testing/index.rst b/dev-docs/source/Testing/index.rst
index 50bb4762187a2b20c7e9ea264253e1ffa5efb7e4..c1384c60fbc4741e326f0af4643451dfe8fbee1e 100644
--- a/dev-docs/source/Testing/index.rst
+++ b/dev-docs/source/Testing/index.rst
@@ -23,7 +23,7 @@ creation is outlined in :ref:`issue_tracking`.
MuonAnalysis_test_guides/index
MuonInterface/MuonTesting
IndirectInelastic/IndirectInelasticAcceptanceTests
- Engineering Diffraction Test Guide
+ EngineeringDiffraction/EngineeringDiffraction2TestGuide
ErrorReporter-ProjectRecovery/ErrorReporterTesting
ErrorReporter-ProjectRecovery/ProjectRecoveryTesting
LiveData/LiveDataTests
diff --git a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleFitOutput.png b/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleFitOutput.png
deleted file mode 100644
index 22bc6ca2543e9c9fafbe47911551951b949fdad3..0000000000000000000000000000000000000000
Binary files a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleFitOutput.png and /dev/null differ
diff --git a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleFocusOutput.png b/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleFocusOutput.png
index 053b8ca057d3b287ababc8bb806a279b71eefdda..82cc29922078d61b1d46e99a275e60ed787d5a7b 100644
Binary files a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleFocusOutput.png and b/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleFocusOutput.png differ
diff --git a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleGSASOutput.png b/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleGSASOutput.png
deleted file mode 100644
index 243e9b1a650f0db305ba2aed4e030806a3f3282d..0000000000000000000000000000000000000000
Binary files a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExampleGSASOutput.png and /dev/null differ
diff --git a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExpectedLinear.png b/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExpectedLinear.png
index bf45283444c91c40665d817c7fb07ee96004e65e..0d556cd63679b91086c086dbf9a2258cbb282d65 100644
Binary files a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExpectedLinear.png and b/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExpectedLinear.png differ
diff --git a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExpectedVanCurve.png b/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExpectedVanCurve.png
index e19afa187aac9ca5616cba58630c89d6dceed9de..0b9967e34278f3b8dfb1a414a497cd9db0f7ad76 100644
Binary files a/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExpectedVanCurve.png and b/dev-docs/source/images/EngineeringDiffractionTest/EnggDiffExpectedVanCurve.png differ
diff --git a/docs/source/algorithms/ApplyCalibration-v1.rst b/docs/source/algorithms/ApplyCalibration-v1.rst
index dfbc03b44aaf0b61614405dcebf6d81b4cbe54c8..92a1b627f2fe9263089df6ffbc4614f13ed3b8e9 100644
--- a/docs/source/algorithms/ApplyCalibration-v1.rst
+++ b/docs/source/algorithms/ApplyCalibration-v1.rst
@@ -9,13 +9,18 @@
Description
-----------
-Update detector positions from input table workspace. The positions are
-updated as absolute positions and so this update can be repeated.
+Update detector calibration from input table workspace. Current calibration properties are:
+- Table column *Detector Position* for absolute positions
+- Table column *Detector Y Coordinate* for absolute position along the vertical (Y) axis
+- Table column *Detector Height* for detector size along the vertical (Y) axis
+- Table column *Detector Width* for detector size along the horizontal (X) axis
-The PositionTable must have columns *Detector ID* and *Detector
-Position*. The entries of the *Detector ID* column are integer referring
-to the Detector ID and the enties of the *Detector Position* are
-:py:obj:`V3Ds <mantid.kernel.V3D>` referring to the position of the detector whose ID is in same row.
+The CalibrationTable must have the column *Detector ID* (integer) and one or more of the following column(s) options:
+- column *Detector Position* of type :py:obj:`V3Ds <mantid.kernel.V3D>`
+- columns *Detector Y Coordinate* (float) and *Detector Height* (float)
+- column *Detector Width* (float)
+
+Notice: The use of property "PositionTable" has been deprecated. Use property "CalibrationTable" instead.
This algorithm is not appropriate for rectangular detectors and won't move them.
@@ -31,48 +36,67 @@ Usage
# Create Workspace with instrument
# We use HRP workspace, which has detectors that are not rectangular.
ws = Load("HRP39180.RAW")
+ compInfo = ws.componentInfo()
+ detInfo = ws.detectorInfo()
- spectra = [0, 1, 3] # Spectra of detectors to be moved
+ spectra = [0, 3] # Spectra of detectors to be moved
# Show positions before calibration
for i in spectra:
- det = ws.getDetector(i)
- print("Position of Detector ID=%i before ApplyCalibration: %.0f,%.0f,%.0f" % (det.getID(),
- det.getPos().X(), det.getPos().Y(), det.getPos().Z()))
-
-
- # Create PositionTable - This would be done by the calibration functions
+ det = ws.getDetector(i)
+ xyz = det.getPos()
+ print("Position of Detector ID=%i before ApplyCalibration: %.1f,%.1f,%.1f" % (det.getID(), xyz.X(), xyz.Y(), xyz.Z()))
+ index = detInfo.indexOf(det.getID()) # detectorInfo and componentInfo index
+ box = compInfo.shape(index).getBoundingBox().width()
+ scalings = compInfo.scaleFactor(index)
+ width, height = box[0] * scalings[0], box[1] * scalings[1]
+ print('Width and Height of Detector ID=%i before ApplyCalibration: %.3f %.3f' % (det.getID(), width, height))
+
+ # Create CalibrationTable - This would be done by the calibration functions
calibTable = CreateEmptyTableWorkspace(OutputWorkspace="CalibTable")
# Add required columns
- calibTable.addColumn(type="int",name="Detector ID")
+ calibTable.addColumn(type="int",name="Detector ID")
calibTable.addColumn(type="V3D",name="Detector Position")
+ calibTable.addColumn(type="double",name="Detector Y Coordinate")
+ calibTable.addColumn(type="double",name="Detector Height")
+ calibTable.addColumn(type="double",name="Detector Width")
# Populate the columns for three detectors
- detIDList = [ ws.getDetector(spectra[0]).getID(), ws.getDetector(spectra[1]).getID(), ws.getDetector(spectra[2]).getID() ]
- detPosList = [ V3D(9.0,0.0,0.0), V3D(10.0,3.0,0.0), V3D(12.0,3.0,6.0)]
+ detIDList = [ws.getDetector(spectra[0]).getID(), ws.getDetector(spectra[1]).getID() ]
+ detPosList = [V3D(9.0,0.0,0.0), V3D(10.0,3.0,0.0)]
+ detYCoord = [0.1, 2.9]
+ detWidthList = [0.011, 0.009]
+ detHeightList = [0.043, 0.052]
for j in range(len(detIDList)):
- nextRow = {'Detector ID': detIDList[j], 'Detector Position': detPosList[j] }
- calibTable.addRow ( nextRow )
-
+ nextRow = {'Detector ID': detIDList[j], 'Detector Position': detPosList[j], 'Detector Y Coordinate': detYCoord[j],
+ 'Detector Width': detWidthList[j], 'Detector Height': detHeightList[j]}
+ calibTable.addRow ( nextRow )
# Apply Calibration to Workspace
- ApplyCalibration ( Workspace=ws, PositionTable=calibTable)
+ ApplyCalibration(Workspace=ws, CalibrationTable=calibTable)
# Show positions after calibration
for i in spectra:
- det = ws.getDetector(i)
- print("Position of Detector ID=%i after ApplyCalibration: %.0f,%.0f,%.0f" % (det.getID(),
- det.getPos().X(), det.getPos().Y(), det.getPos().Z()))
+ det = ws.getDetector(i)
+ xyz = det.getPos()
+ print("Position of Detector ID=%i after ApplyCalibration: %.1f,%.1f,%.1f" % (det.getID(), xyz.X(), xyz.Y(), xyz.Z()))
+ index = detInfo.indexOf(det.getID()) # detectorInfo and componentInfo index
+ box = compInfo.shape(index).getBoundingBox().width()
+ scalings = compInfo.scaleFactor(index)
+ width, height = box[0] * scalings[0], box[1] * scalings[1]
+ print('Width and Height of Detector ID=%i after ApplyCalibration: %.3f %.3f' % (det.getID(), width, height))
Output:
.. testoutput:: ExApplyCalibSimple
- Position of Detector ID=1100 before ApplyCalibration: 0,0,-1
- Position of Detector ID=1101 before ApplyCalibration: 0,0,-1
- Position of Detector ID=1103 before ApplyCalibration: 0,0,-1
- Position of Detector ID=1100 after ApplyCalibration: 9,0,0
- Position of Detector ID=1101 after ApplyCalibration: 10,3,0
- Position of Detector ID=1103 after ApplyCalibration: 12,3,6
+ Position of Detector ID=1100 before ApplyCalibration: 0.0,0.1,-0.9
+ Width and Height of Detector ID=1100 before ApplyCalibration: 0.010 0.049
+ Position of Detector ID=1103 before ApplyCalibration: 0.0,0.1,-0.9
+ Width and Height of Detector ID=1103 before ApplyCalibration: 0.010 0.054
+ Position of Detector ID=1100 after ApplyCalibration: 9.0,0.1,0.0
+ Width and Height of Detector ID=1100 after ApplyCalibration: 0.011 0.043
+ Position of Detector ID=1103 after ApplyCalibration: 10.0,2.9,0.0
+ Width and Height of Detector ID=1103 after ApplyCalibration: 0.009 0.052
.. categories::
diff --git a/docs/source/algorithms/LoadPSIMuonBin-v1.rst b/docs/source/algorithms/LoadPSIMuonBin-v1.rst
index 447ecfe9190ac58359f9536205982b2599703ec5..89247933f629df2ba1e858511c5dceed90da3270 100644
--- a/docs/source/algorithms/LoadPSIMuonBin-v1.rst
+++ b/docs/source/algorithms/LoadPSIMuonBin-v1.rst
@@ -25,6 +25,10 @@ Any temperature data loaded in from a separate file will be available
from the resultant workspace's sample logs, as a number series that
is plottable.
+The times are automatically offset by the value for first good data, such that the pulse is at approximatly time equals zero. This is to be consistant with ISIS measurement data.
+
+If no group name is recorded in the data file a name of `group_specNum` will be used, where `specNum` is the spectrum number.
+
Errors
######
diff --git a/docs/source/algorithms/ReflectometryISISLoadAndProcess-v1.rst b/docs/source/algorithms/ReflectometryISISLoadAndProcess-v1.rst
index 7609a80c472a690c32edf8b91a50f30e52c4f091..242ef733ec9e7c7d250954b31a70a680087d19b4 100644
--- a/docs/source/algorithms/ReflectometryISISLoadAndProcess-v1.rst
+++ b/docs/source/algorithms/ReflectometryISISLoadAndProcess-v1.rst
@@ -14,21 +14,27 @@ This algorithm performs full preparation and processing for a single run or comb
The steps this algorithm performs are:
-- Ensure the required workspaces are loaded.
-- Optionally sum multiple runs into a single input run prior to reduction.
-- Optionally sum multiple transmission runs into a single input prior to reduction.
-- Optionally perform time-slicing of the input run.
-- Validate that the workspaces are the correct type.
-- Run ReflectometryReductionOneAuto to perform the reduction.
-- Group the TOF workspaces into a group called `TOF`
+- Ensure workspaces are loaded and are of the correct type.
+- Sum multiple input runs into a single workspace, if there is more than one.
+- Sum multiple transmission runs into a single workspace, if there is more than one.
+- Perform background subtraction, if requested.
+- Perform time-slicing of the input run, if requested.
+- Perform the reduction.
+- Clean up the TOF workspaces into a group.
-Input runs and transmission runs are loaded if required, or existing workspaces are used if they are already in the ADS. When runs are loaded, they are named based on the run number with a ``TOF_`` or ``TRANS_`` prefix. To determine whether workspaces are already in the ADS, workspace names are matched based on the run number with or without this prefix. Other naming formats are not considered to match.
+Input runs and transmission runs are loaded if required, or existing workspaces are used if they are already loaded. When runs are loaded, they are named based on the run number with a ``TOF_`` or ``TRANS_`` prefix. To determine whether workspaces are already loaded, workspace names are matched based on the run number with or without this prefix. Other naming formats are not considered to match.
-Input runs can be combined before reduction by supplying a comma-separated list of run numbers. They will be summed using the :ref:`algm-Plus` algorithm. Similarly, multiple input runs for the first and/or second transmission workspace inputs can be summed prior to reduction.
+If time slicing is enabled, the input run must be an event workspace and have monitors loaded; otherwise, it must be a histogram workspace. If the workspace already exists but is the incorrect type or is missing monitors, it will be reloaded.
-For time slicing, the input run must be an event workspace. If the workspace for the run already exists in the ADS but is the incorrect type, or does not have monitors loaded, it will be reloaded.
+Input runs can be combined before reduction by supplying a comma-separated list of run numbers. They will be summed using the :ref:`algm-Plus` algorithm. Similarly, multiple input workspaces for the first and/or second transmission inputs can be summed prior to reduction.
-Input properties for the reduction are the same as those for :ref:`algm-ReflectometryReductionOneAuto`.
+If ``SubtractBackground`` is true, then background subtraction will be performed using the :ref:`algm-ReflectometryBackgroundSubtraction` algorithm. There are various options for specifying how the subtraction should be done.
+
+If ``SliceWorkspace`` is true, the time slicing will be performed using the :ref:`algm-ReflectometrySliceEventWorkspace` algorithm. Various options are available for specifying the filter to use and slicing can be done by time or by log value.
+
+The reduction is performed using :ref:`algm-ReflectometryReductionOneAuto`.
+
+Finally, the TOF workspaces are cleaned up by grouping them into a workspace group named ``TOF``. If a group by this name already exists then they will be added to that group.
Usage
-------
diff --git a/docs/source/algorithms/ReflectometryReductionOne-v2.rst b/docs/source/algorithms/ReflectometryReductionOne-v2.rst
index 61a694bdcdd82d872aaa39b702f588c2f58f4010..9e722fbdbaa6d20f1bb23699e72af4e6fe2b22f0 100644
--- a/docs/source/algorithms/ReflectometryReductionOne-v2.rst
+++ b/docs/source/algorithms/ReflectometryReductionOne-v2.rst
@@ -253,17 +253,17 @@ Output:
trans1 = Load(Filename='INTER00013463.nxs')
trans2 = Load(Filename='INTER00013464.nxs')
# Basic reduction with two transmission runs
- IvsQ, IvsLam = ReflectometryReductionOne(InputWorkspace=run,
- WavelengthMin=1.0,
- WavelengthMax=17.0,
- ProcessingInstructions='4',
- I0MonitorIndex=2,
- MonitorBackgroundWavelengthMin=15.0,
- MonitorBackgroundWavelengthMax=17.0,
- MonitorIntegrationWavelengthMin=4.0,
- MonitorIntegrationWavelengthMax=10.0,
- FirstTransmissionRun=trans1,
- SecondTransmissionRun=trans2)
+ IvsQ, IvsLam, TRANS = ReflectometryReductionOne(InputWorkspace=run,
+ WavelengthMin=1.0,
+ WavelengthMax=17.0,
+ ProcessingInstructions='4',
+ I0MonitorIndex=2,
+ MonitorBackgroundWavelengthMin=15.0,
+ MonitorBackgroundWavelengthMax=17.0,
+ MonitorIntegrationWavelengthMin=4.0,
+ MonitorIntegrationWavelengthMax=10.0,
+ FirstTransmissionRun=trans1,
+ SecondTransmissionRun=trans2)
print("{:.4f}".format(IvsLam.readY(0)[480]))
print("{:.4f}".format(IvsLam.readY(0)[481]))
diff --git a/docs/source/algorithms/ReflectometryReductionOneAuto-v2.rst b/docs/source/algorithms/ReflectometryReductionOneAuto-v2.rst
index d2becb115cf982b7828ef3e189e1a4f8096b5f3b..6f1ff3494b4fc3960ac762f498bd4ae4baf5aa20 100644
--- a/docs/source/algorithms/ReflectometryReductionOneAuto-v2.rst
+++ b/docs/source/algorithms/ReflectometryReductionOneAuto-v2.rst
@@ -150,7 +150,7 @@ Usage
.. testcode:: ExReflRedOneAutoSimple
run = Load(Filename='INTER00013460.nxs')
- IvsQ, IvsQ_unbinned = ReflectometryReductionOneAuto(InputWorkspace=run, ThetaIn=0.7)
+ IvsQ, IvsQ_unbinned = ReflectometryReductionOneAuto(InputWorkspace=run, ThetaIn=0.7, Version=2)
print("{:.5f}".format(IvsQ_unbinned.readY(0)[106]))
print("{:.5f}".format(IvsQ_unbinned.readY(0)[107]))
@@ -172,7 +172,7 @@ Output:
run = Load(Filename='INTER00013460.nxs')
trans = Load(Filename='INTER00013463.nxs')
- IvsQ, IvsQ_unbinned = ReflectometryReductionOneAuto(InputWorkspace=run, FirstTransmissionRun=trans, ThetaIn=0.7)
+ IvsQ, IvsQ_unbinned = ReflectometryReductionOneAuto(InputWorkspace=run, FirstTransmissionRun=trans, ThetaIn=0.7, Version=2)
print("{:.5f}".format(IvsQ_unbinned.readY(0)[96]))
print("{:.5f}".format(IvsQ_unbinned.readY(0)[97]))
@@ -193,7 +193,7 @@ Output:
.. testcode:: ExReflRedOneAutoOverload
run = Load(Filename='INTER00013460.nxs')
- IvsQ, IvsQ_unbinned = ReflectometryReductionOneAuto(InputWorkspace=run, ThetaIn=0.7, DetectorCorrectionType="RotateAroundSample", MonitorBackgroundWavelengthMin=0.0, MonitorBackgroundWavelengthMax=1.0)
+ IvsQ, IvsQ_unbinned = ReflectometryReductionOneAuto(InputWorkspace=run, ThetaIn=0.7, DetectorCorrectionType="RotateAroundSample", MonitorBackgroundWavelengthMin=0.0, MonitorBackgroundWavelengthMax=1.0, Version=2)
print("{:.5f}".format(IvsQ_unbinned.readY(0)[106]))
print("{:.5f}".format(IvsQ_unbinned.readY(0)[107]))
diff --git a/docs/source/algorithms/ReflectometryReductionOneAuto-v3.rst b/docs/source/algorithms/ReflectometryReductionOneAuto-v3.rst
index 1d3b3799627d01e8d6d2d5349a60df2cfc7721d3..fd94d0c08c0aa96ed0aa76b9a73857aadaba0985 100644
--- a/docs/source/algorithms/ReflectometryReductionOneAuto-v3.rst
+++ b/docs/source/algorithms/ReflectometryReductionOneAuto-v3.rst
@@ -157,7 +157,7 @@ Output:
run = Load(Filename='INTER00013460.nxs')
trans = Load(Filename='INTER00013463.nxs')
- IvsQ, IvsQ_unbinned = ReflectometryReductionOneAuto(InputWorkspace=run, FirstTransmissionRun=trans, ThetaIn=0.7)
+ IvsQ, IvsQ_unbinned, IvsLam, TRANS = ReflectometryReductionOneAuto(InputWorkspace=run, FirstTransmissionRun=trans, ThetaIn=0.7)
print("{:.5f}".format(IvsQ_unbinned.readY(0)[96]))
print("{:.5f}".format(IvsQ_unbinned.readY(0)[97]))
diff --git a/docs/source/algorithms/SavePDFGui-v1.rst b/docs/source/algorithms/SavePDFGui-v1.rst
index 92352598e21e3f2abbb308ce4161a5fac7aa3d78..d09065908d9999130f919cb886c142a468259519 100644
--- a/docs/source/algorithms/SavePDFGui-v1.rst
+++ b/docs/source/algorithms/SavePDFGui-v1.rst
@@ -15,10 +15,6 @@ The body of the file is of the form ``r Gr dr dGr``.
Usage
-----
-.. Try not to use files in your examples,
- but if you cannot avoid it then the (small) files must be added to
- autotestdata\UsageData and the following tag unindented
- .. include:: ../usagedata-note.txt
**Example - SavePDFGui**
diff --git a/docs/source/algorithms/SaveRMCProfile-v1.rst b/docs/source/algorithms/SaveRMCProfile-v1.rst
new file mode 100644
index 0000000000000000000000000000000000000000..1bc8ba290a349eb9ebed65a6efb06460302c31bb
--- /dev/null
+++ b/docs/source/algorithms/SaveRMCProfile-v1.rst
@@ -0,0 +1,56 @@
+
+.. algorithm::
+
+.. summary::
+
+.. relatedalgorithms::
+
+.. properties::
+
+Description
+-----------
+
+This algorithm saves files consistent with `RMCProfile <http://www.rmcprofile.org/Main_Page/>`_.
+The header of the file contains the number of data points in the file, the function type,
+and a title for the data. The body of the file is of the form ``x y``.
+
+Usage
+-----
+
+**Example - SaveRMCProfile**
+
+.. testcode:: SaveRMCProfileExample
+
+ # Create a host workspace
+ ws = CreateWorkspace(DataX=range(0,3), DataY=range(0,3), UnitX="Angstrom")
+
+ # Create a filename
+ import os
+ path = os.path.join(os.path.expanduser("~"), "SaveRMCProfile.fq")
+
+ # Save as G(r) file
+ SaveRMCProfile(InputWorkspace=ws, InputType="G(r)", Title="Data_title", Filename=path)
+
+ # Check that the file exists
+ print(os.path.isfile(path))
+
+Output:
+
+.. testoutput:: SaveRMCProfileExample
+
+ True
+
+.. testcleanup:: SaveRMCProfileExample
+
+ DeleteWorkspace(ws)
+ import os
+ try:
+ path = os.path.join(os.path.expanduser("~"), "SaveRMCProfile.fq")
+ os.remove(path)
+ except:
+ pass
+
+.. categories::
+
+.. sourcelink::
+
diff --git a/docs/source/api/python/mantid/plots/index.rst b/docs/source/api/python/mantid/plots/index.rst
index 59534b3ec6d99a49ff3c6107cc222c5351918229..6ed16c5410b820592d4b738150326231d4f8a16c 100644
--- a/docs/source/api/python/mantid/plots/index.rst
+++ b/docs/source/api/python/mantid/plots/index.rst
@@ -243,7 +243,7 @@ When using ``mantid3d`` projection
Functions to use when **mantid** projection is not available
------------------------------------------------------------
-.. automodule:: mantid.plots.plotfunctions
+.. automodule:: mantid.plots.axesfunctions
:members: plot, errorbar, scatter, contour, contourf, pcolor,
pcolorfast, pcolormesh, tripcolor, tricontour, tricontourf
@@ -251,13 +251,13 @@ Functions to use when **mantid** projection is not available
Functions to use when **mantid3d** projection is not available
--------------------------------------------------------------
-.. automodule:: mantid.plots.plotfunctions3D
+.. automodule:: mantid.plots.axesfunctions3D
:members: plot, scatter, plot_wireframe, plot_surface,
contour, contourf
Helper functions
----------------
-.. automodule:: mantid.plots.helperfunctions
+.. automodule:: mantid.plots.datafunctions
:members: get_distribution, get_normalization,
points_from_boundaries, boundaries_from_points,
get_wksp_index_dist_and_label, get_md_data, get_md_data1d,
diff --git a/docs/source/interfaces/Engineering Diffraction 2.rst b/docs/source/interfaces/Engineering Diffraction 2.rst
index 77ca183072202544439271b282e942359ad3af96..abcd46ea6de7f44b6cc30a3b1cd46933990b991b 100644
--- a/docs/source/interfaces/Engineering Diffraction 2.rst
+++ b/docs/source/interfaces/Engineering Diffraction 2.rst
@@ -11,8 +11,9 @@ Interface Overview
This custom interface will integrate several tasks related to engineering
diffraction. In its current state it provides functionality for creating
-and loading calibration files, focusing ENGINX run files, and performing
-single peak fitting on focused run files.
+and loading calibration files and focusing ENGINX run files.
+
+Functionality for performing single peak fitting on focused run files is currently in progress.
This interface is under active development.
@@ -66,7 +67,7 @@ to the same directory:
If an RB number has been specified the files will also be saved to a user directory
in the base directory:
-`<CHOSEN_OUTPUT_DIRECTORY>/User/RBNumber/Calibration/`
+`<CHOSEN_OUTPUT_DIRECTORY>/User/<RB_NUMBER>/Calibration/`
Cropping
^^^^^^^^
@@ -97,35 +98,42 @@ Custom Spectra
Focus
-----
-This tab allows for the focusing of data files, by providing a run number or selecting the files
-manually using the browse button, by making use of the :ref:`EnggFocus<algm-EnggFocus>` algorithm.
+This tab allows for the focusing of data files by making use of the :ref:`EnggFocus<algm-EnggFocus>` algorithm.
+
+Files can be selected by providing run numbers or selecting the files manually using the browse button.
-In order to use the tab, a new or existing calibration must be created or loaded.
+In order to use the tab, a new or existing calibration must be created or loaded (see above).
-Currently, the focusing tab only supports one focusing mode:
+The interface allows for two kinds of focusing:
- **Normal Focusing:**
- A run number can be entered and both banks will be focused.
- The output workspaces will have a suffix denoting which bank they are for.
+ Run numbers can be entered and both banks will be focused for each workspace.
+ The output workspaces will have a prefix for the run they are for and a suffix denoting which bank they are for.
- **Cropped Focusing:**
The entered workspace can be cropped to one of the two banks or to a user defined set of spectra.
- Custom cropped workspaces will have the suffix "cropped".
+ Workspaces cropped using custom spectra lists will have the suffix "cropped".
-The focused data files are saved in NeXus format to:
+Ticking the "Plot Focused Workspace" checkbox will create a plot of the focused workspace when the algorithm is
+complete. The number of plots that are generated is dependent on the type of focusing done. Normal focusing generates
+a plot for each bank and cropped focusing generates a plot for the single bank or one for the chosen spectra.
-`Engineering_Mantid/Focus/`
+Clicking the focus button will begin the focusing algorithm for the selected run files. The button and plotting checkbox
+will be disabled until the fitting algorithm is complete.
-If an RB number has been specified the files will also be saved to a user directory
-in the base directory:
+The focused output files are saved in NeXus, GSS, and raw XYE format to:
+
+`<CHOSEN_OUTPUT_DIRECTORY>/Focus/`
-`Engineering_Mantid/User/RBNumber/Focus/`
+If an RB number has been specified the files will also be saved to a user directory:
+
+`<CHOSEN_OUTPUT_DIRECTORY>/User/<RB_NUMBER>/Focus/`
Parameters
^^^^^^^^^^
Sample Run Number
- The run number or file path to the data file to be focused.
+ The run numbers of or file paths to the data files to be focused.
Bank/Spectra
Select which bank to restrict the focusing to or allow for the entry of custom spectra.
@@ -137,14 +145,27 @@ Custom Spectra
Fitting
-------
-This tab allows for single peak fitting of focused run files.
+**This tab is currently a work in progress!**
+
+This tab will allow for single peak fitting of focused run files.
Focused run files can be loaded from the file system into mantid from the interface, which will keep track of all the
workspaces that it has created from these files.
+The plan for the rest of the functionality is to allow for loaded workspaces to be plotted in the interface. Peaks
+could then be selected by clicking on the plot or by using a text field to enter peak centres in d-spacing.
+Once the peaks have been selected, they would be fitted using the :ref:`Pseudo-Voigt <func-PseudoVoigt>` and
+:ref:`BackToBackExponential <func-BackToBackExponential>` fit functions.
+
+The output from the fitting functions will be stored in a multidimensional file format, along with the sample logs for
+the runs that have been fitted.
+
Parameters
^^^^^^^^^^
Focused Run Files
A comma separated list of files to load. Selecting files from the file system using the browse button will do this
for you.
+
+Peak Positions
+ A comma separated list of peak positions to be used when performing the fit.
diff --git a/docs/source/plotting/index.rst b/docs/source/plotting/index.rst
index 3c07d3428d7c542b653582e04936024a387861cc..3e978b618647481eb9c4285238c133146ee96cf8 100644
--- a/docs/source/plotting/index.rst
+++ b/docs/source/plotting/index.rst
@@ -722,19 +722,19 @@ beginning of the run), but one can also plot absolute time using `FullTime=True`
Note that the parasite axes in matplotlib do not accept the projection keyword.
-So one needs to use :func:`mantid.plots.plotfunctions.plot<mantid.plots.plotfunctions.plot>` instead.
+So one needs to use :func:`mantid.plots.axesfunctions.plot<mantid.plots.axesfunctions.plot>` instead.
.. plot::
:include-source:
import matplotlib.pyplot as plt
- from mantid import plots
+ import mantid.plots.axesfunctions as axesfuncs
from mantid.simpleapi import Load
w=Load('CNCS_7860')
fig, ax = plt.subplots(subplot_kw={'projection':'mantid'})
ax.plot(w,LogName='ChopperStatus5')
axt=ax.twiny()
- plots.plotfunctions.plot(axt,w,LogName='ChopperStatus5', FullTime=True)
+ axesfuncs.plot(axt,w,LogName='ChopperStatus5', FullTime=True)
#fig.show()
Complex plots
diff --git a/docs/source/release/v4.3.0/diffraction.rst b/docs/source/release/v4.3.0/diffraction.rst
index 308e72d164c73f48fa05fe710f6ba6c75aa1bc64..66a7783e430dc88f71c0a047efc32b59079dcf98 100644
--- a/docs/source/release/v4.3.0/diffraction.rst
+++ b/docs/source/release/v4.3.0/diffraction.rst
@@ -9,6 +9,13 @@ Diffraction Changes
putting new features at the top of the section, followed by
improvements, followed by bug fixes.
+New Features
+############
+
+Engineering Diffraction
+-----------------------
+- Introduction of Engineering Diffraction 2 interface. Currently supports calibration and focusing for ENGINX.
+
Improvements
############
@@ -25,6 +32,7 @@ Powder Diffraction
- The polaris create_total_scattering_pdf function can now accept a `pdf_type` argument to set the pdf_output type.
- The polaris create_total_scattering_pdf function can now accept a `freq_params` argument to perform a fourier filter on the run.
- :ref:`HRPDSlabCanAbsorption <algm-HRPDSlabCanAbsorption-v1>` now accepts any thickness parameter and not those in a specified list.
+- A SaveRDFProfile algorithm has been made that saves workspaces in a format readable by the RMCProfile package.
Engineering Diffraction
-----------------------
@@ -55,6 +63,8 @@ Powder Diffraction
- A bug has been fixed that caused Polaris.focus to fail with `do_absorption_Corrections=True`.
- A bug has been fixed that caused empty runs to be subtracted twice when specifying `sample_empty` in `Polaris.focus`.
- A bug has been fixed that prevented lists being given for `q_lims` in polaris create_total_scattering_pdf while merging banks.
+- A bug has been fixed that caused SavePDF to fail when asked to save histogram data
+- A bug has been fixed that prevented lists being given for `q_lims` in polaris create_total_scattering_pdf while merging banks.
Engineering Diffraction
-----------------------
diff --git a/docs/source/release/v4.3.0/direct_geometry.rst b/docs/source/release/v4.3.0/direct_geometry.rst
index 5d222de726e664006ef876a223158fc3fe95d438..e55f76918e8d8a31f7f250b740df3a4a0f686ee1 100644
--- a/docs/source/release/v4.3.0/direct_geometry.rst
+++ b/docs/source/release/v4.3.0/direct_geometry.rst
@@ -9,8 +9,19 @@ Direct Geometry Changes
putting new features at the top of the section, followed by
improvements, followed by bug fixes.
+New
+###
+
* New ``NOW4`` instrument definition for SNS
+Improvements
+############
+
- For Panther and IN5 the :ref:`DirectILLReduction <algm-DirectILLReduction-v1>` will now correctly mask the non-overlapping bins before grouping the pixels onto Debye-Scherrer rings.
+BugFixes
+########
+
+- Fixed a bug in the :ref:`Crystal Field Python Interface` which prevented users from defining a cubic crystal field model.
+
:ref:`Release 4.3.0 <v4.3.0>`
diff --git a/docs/source/release/v4.3.0/framework.rst b/docs/source/release/v4.3.0/framework.rst
index 3a281dbec901c18874ac3884bce154868d35a2c3..2d248cf59cb6bfb39dc06e48add008cdb11b39b7 100644
--- a/docs/source/release/v4.3.0/framework.rst
+++ b/docs/source/release/v4.3.0/framework.rst
@@ -25,6 +25,7 @@ Improvements
- Prevent units that are not suitable for :ref:`ConvertUnits <algm-ConvertUnits>` being entered as the target unit.
- Fixed an uncaught exception when plotting logs on single spectrum workspaces in mantidworkbench
- Save the units for single value logs in :ref:`SaveNexusProcessed <algm-SaveNexusProcessed>`
+- Ties set to peaks in crystal field fits now work correctly.
- Error bars on calculated normalized fits are now correct.
Algorithms
@@ -39,6 +40,9 @@ Improvements
- :ref:`MatchAndMergeWorkspaces <algm-MatchAndMergeWorkspaces>` will merge workspaces in a workspace group withing weighting from a set of limits for each workspace and using `MatchSpectra <algm-MatchSpectra>`.
- :ref:`MonteCarloAbsorption <algm-MonteCarloAbsorption>` Sampling of scattering points during MC simulation now takes into account relative volume of sample and environment components. The calculation also now reuses the same set of simulated tracks to calculate the attenuation for different wavelengths. A new parameter ResimulateTracksForDifferentWavelengths has been added to control this behaviour with a default value of false. NOTE: This has been inserted in the middle of the parameter list so any usage of positional parameters with this algorithm will need to be adjusted
- :ref:`AddSampleLogMultiple <algm-AddSampleLogMultiple>` Add parameter LogTypes to specify the type of each log value.
+- :ref:`ApplyCalibration <algm-ApplyCalibration>` can now independently change the pixel heights, widths, and Y-coordinate. Property "PositionTable" has been deprecated and property "CalibrationTable" should be used in its place.
+
+
Data Handling
-------------
@@ -49,11 +53,10 @@ Improvements
- The sampleenvironment xml files that act as extensions to the Instrument Definition Files can now support stl file paths to load mesh geometries for environment components or the sample from an .stl file. This new feature can be used when running SetSample. A sample environment xml file has been created for Pearl
+
Data Objects
------------
-
-
Geometry
--------
diff --git a/docs/source/release/v4.3.0/indirect_geometry.rst b/docs/source/release/v4.3.0/indirect_geometry.rst
index 0a23d7937f66308477700c06c22477f309473277..9a09341d5826b9d4353ba5c8f3acb345df48bebf 100644
--- a/docs/source/release/v4.3.0/indirect_geometry.rst
+++ b/docs/source/release/v4.3.0/indirect_geometry.rst
@@ -13,6 +13,7 @@ New
###
- Simultaneous fitting has been added as an option on the convolutional fitting tab of data analysis.
+ - Simultaneous fitting has been added as an option on the FQ fitting tab of data analysis.
Improvements
############
@@ -29,11 +30,27 @@ Improvements
histogram bins. (Previously the values would correspond to one
bin-edge.)
+- In Abins the iterative thresholding system, which was used to
+ suppress high-intensity terms at high quantum orders, has been
+ removed.
+
+ - Instead, a user warning is printed at the end of the calculation
+ (before writing files) if the threshold for small values (set in
+ AbinsParameters.sampling) was large compared to the data.
+ - This will lead to performance improvements for systems with
+ large second-order contributions.
+ - Calculation of third- and fourth-order spectra is disabled while
+ the implementation of these terms is reviewed. Benchmarking has
+ shown that the results of these terms are unreasonably large, and
+ are not recommended for production calculations.
+
BugFixes
########
- The Abins file parser no longer fails to read data from non-periodic vibration calculations performed with CRYSTAL17.
- :ref:`ApplyPaalmanPingsCorrection <algm-ApplyPaalmanPingsCorrection>` will now run also for fixed window scan reduced data and will not crash on workspace groups.
- Fixed a bug crashing the ``Indirect ILL Data Reduction GUI`` when Run is clicked.
+- Indirect ILL reductions for BATS and Doppler QENS modes will now flag the outputs as distributions if the data is normalised by the monitor.
+- :ref:`IndirectILLReductionFWS <algm-IndirectILLReductionFWS>` will now allow for manual setting of the inelastic peak channels.
:ref:`Release 4.3.0 <v4.3.0>`
diff --git a/docs/source/release/v4.3.0/mantidworkbench.rst b/docs/source/release/v4.3.0/mantidworkbench.rst
index e6e7e049db919ca8e095462563cb274263d53b0e..2b0b2b7843f2d394075f9757145ed67e73ae52ff 100644
--- a/docs/source/release/v4.3.0/mantidworkbench.rst
+++ b/docs/source/release/v4.3.0/mantidworkbench.rst
@@ -9,6 +9,49 @@ New
###
- Waterfall Plots
- Mantid Workbench can now load all of the workspaces from projects saved from Mantidplot. Graphs and interface values are not imported from the project.
+- Added a compatibility implementation of plotSpectrum and plotBin for python scripts in Workbench, all of the previous arguments are supported with the exception of distributionwhich will be ignored. For example the following commands are supported.
+
+.. code-block:: python
+
+ #setup a couple of workspaces
+ ws = CreateSampleWorkspace(Function='Powder Diffraction')
+ ws2 = ws+ws
+
+ #simple plots
+ plotSpectrum(ws ,1)
+ plotBin(ws ,1)
+
+ #With Error Bars
+ plotSpectrum(ws ,1,error_bars=True)
+ plotBin(ws ,1,error_bars=True)
+
+ #Multi line plots
+ plotSpectrum([ws ,ws2],1)
+ plotBin([ws ,ws2],1)
+ plotSpectrum([ws ,ws2],[1,2,3])
+ plotBin([ws ,ws2],[1,2,3])
+ plotSpectrum(["ws ","ws2"],[1,2,3])
+
+ #plotting with spectra numbers
+ plotSpectrum(ws,spectrum_nums=2,error_bars=True)
+ plotSpectrum(ws,spectrum_nums=[2,4,6])
+ plotSpectrum([ws,ws2],spectrum_nums=list(range(2,10)))
+
+ # add a curve to an existing plot
+ plot1 = plotSpectrum(ws ,1,error_bars=True)
+ plot1 = plotSpectrum(ws ,error_bars=True,window=plot1)
+
+ # clear an existing plot use that window to plot
+ plot2 = plotSpectrum(ws ,1,error_bars=True)
+ plot2 = plotSpectrum(ws2,1,error_bars=True,window=plot2, clearWindow = True)
+
+ # plot as points not lines
+ plotSpectrum(ws ,1,error_bars=True,type=1)
+ plotBin(ws ,1,type=1)
+
+ # plot as waterfall graphs
+ plotSpectrum(["ws","ws2"],[1,2,3],waterfall=True)
+
Improvements
############
@@ -37,19 +80,30 @@ Improvements
- The context menu for WorkspaceGroups now contains plotting options so you can plot all of the workspaces in the group.
- Most changes in the settings dialog now take place immediately, no longer needing a restart, such as hiding algorithm categories, interfaces or choosing wether to see invisible workspaces.
- A warning now appears if you attempt to plot more than ten spectra.
+- We have limited the maximum rate of algorithm progress updates to the progress bar to 1000/second. This has resulted in a workbench completing certain intensive python scripts 4 times faster.
+- Algorithm dialogs will now use the selected workspace as the InputWorkspace when running an algorithm from the algorithms toolbox, as MantidPlot did.
+- Toggle Whitespace in the editor now shows line endings as well as spaces and tabs
- The Save menu action in the workspaces toolbox to save using version 1 of the SaveAscii algorithm has been removed as no one was using it and it only added confusion. The option to save using the most recent version of SaveASCII is still available.
- You can now search for functions when doing fits.
+- A help button has been added to the fitting add function dialog.
+- The progress reporting for scripts has been vastly improved and now reports at the line level.
Bugfixes
########
- Fixed an issue with Workspace History where unrolling consecutive workflow algorithms would result in only one of the algorithms being unrolled.
+- Workbench now saves python files properly on windows and does not double up on line feed characters.
- Fixed a couple of errors in the python scripts generated from plots for newer versions of Matplotlib.
- Colorbar scale no longer vanish on colorfill plots with a logarithmic scale
- Figure options no longer causes a crash when using 2d plots created from a script.
+- You can now execute algorithms with multiple versions by double clicking on them in the algorithm toolbox, this will now execute them rather than opening the tree to show previous versions. You can still click on the arrow to see and execute previous versions.
- Running an algorithm that reduces the number of spectra on an active plot (eg SumSpectra) no longer causes an error
- Fix crash when loading a script with syntax errors
- The Show Instruments right click menu option is now disabled for workspaces that have had their spectrum axis converted to another axis using :ref:`ConvertSpectrumAxis <algm-ConvertSpectrumAxis>`. Once this axis has been converetd the workspace loses it's link between the data values and the detectors they were recorded on so we cannot display it in the instrument view.
- MonitorLiveData now appears promptly in the algorithm details window, allowing live data sessions to be cancelled.
- Figure options on bin plots open without throwing an error.
+- The help button in fitting now finds the relevant page.
+- Fixed an issue where fitting a distribution workspace was normalised twice.
+- Overplots will be normalized by bin width if they are overplotting a curve from a workspace which is a distribution.
+- Several bugs in the way Python scripts were parsed and executed, including blank lines after a colon and tabs in strings, have been fixed.
:ref:`Release 4.3.0 <v4.3.0>`
diff --git a/docs/source/release/v4.3.0/muon.rst b/docs/source/release/v4.3.0/muon.rst
index 94c64d6c9e1368ee6580f2e9d92b0e469a77f01b..c0b36067b1406f474a6a38d87c5d685abda151e0 100644
--- a/docs/source/release/v4.3.0/muon.rst
+++ b/docs/source/release/v4.3.0/muon.rst
@@ -14,6 +14,11 @@ Improvements
Algorithms
-------------
+Bug Fixes
+#########
+- :ref:`LoadPSIMuonBin <algm-LoadPSIMuonBin>` can produce an empty dead time table, the time data is offset such that the start of thepulse is at time zero. The start and end date logs have been fixed and if no group name is present a default is generated.
+
+
Muon Analysis 2 and Frequency Domain Interfaces
---------------------------------------------------
- The plotting window within the Muon Analysis 2 and Frequency Domain Interfaces has been converted into a dockable window,
@@ -26,6 +31,7 @@ Muon Analysis 2 and Frequency Domain Interfaces
part due to the new tiled plotting feature.
- Added a plotting options toolbar to the docked plotting in the Muon Analysis 2 and Frequency Domain interfaces. This toolbar
can be used to autoscale the axes, change the axes limits, and control the plotting of errors.
+- Fixed a bug that prevented PSI data from being loaded.
- Reworked the fitting tab to improve the user experience when doing single, and simultaneous fits.
- Addition of a sequential fitting tab, enabling both sequential, and simultaneous sequential fits.
@@ -35,5 +41,6 @@ Bug Fixes
- The elemental analysis GUI can now handle legacy data which is missing a response dataset, e.g Delayed.
- Fixed a bug with constraints in the Muon Analysis 2 GUI which would cause Mantid to crash.
- Fixed a bug in Muon Analysis Old that prevented the muon fitting functions from appearing in the data analysis tab.
+- Data sets can now be reloaded while the Instrument View is open without crashing Mantid.
:ref:`Release 4.3.0 <v4.3.0>`
\ No newline at end of file
diff --git a/docs/source/release/v4.3.0/reflectometry.rst b/docs/source/release/v4.3.0/reflectometry.rst
index 2c3c0befb271c265f50159057041454240249d6e..d618f582e960333e5811b491fc68920bba3148aa 100644
--- a/docs/source/release/v4.3.0/reflectometry.rst
+++ b/docs/source/release/v4.3.0/reflectometry.rst
@@ -2,13 +2,22 @@
Reflectometry Changes
=====================
+.. contents:: Table of Contents
+ :local:
+
+.. warning:: **Developers:** Sort changes under appropriate heading
+ putting new features at the top of the section, followed by
+ improvements, followed by bug fixes.
+
ISIS Reflectometry Interface
############################
+**The old ISIS Reflectometry Interface has been removed. If required then please use the previous release, version 4.2.0**
+
Improved
--------
-- The per-angle defaults table on the Experiment now has column-specific tooltips on the table cells.
+- The per-angle defaults table on the Experiment now has column-specific tooltips on the table cells which correspond to the [ReflectometryISISLoadAndProcess](https://docs.mantidproject.org/nightly/algorithms/ReflectometryISISLoadAndProcess-v1.html?highlight=reflectometryisisloadandprocess) documentation
Algorithms
##########
@@ -18,13 +27,25 @@ New
- The new workflow algorithm :ref:`algm-ReflectometryILLAutoProcess` performs the complete data reduction for ILL reflectometers D17 and Figaro. Implements both coherent and incoherent summation types.
-.. contents:: Table of Contents
- :local:
+- New output properties have been added for the ISIS Reflectometry algorithms for transmission workspaces so that history is now attached to these outputs.
-.. warning:: **Developers:** Sort changes under appropriate heading
- putting new features at the top of the section, followed by
- improvements, followed by bug fixes.
+ - The affected algorithms are: :ref:`algm-CreateTransmissionWorkspace`, :ref:`algm-ReflectometryReductionOne`, :ref:`algm-ReflectometryReductionOneAuto`, :ref:`algm-ReflectometryISISLoadAndProcess`.
+
+ - **Note that this may break existing scripts if you assign outputs directly to a python list**
+
+ e.g. if previously you called an algorithm as:
+
+ ``IvsQ, IvsQ_unbinned = ReflectometryReductionOneAuto(InputWorkspace=run, FirstTransmissionRun=trans, ThetaIn=0.7)``
+
+ then this will now need to be as follows (note that the optional ``IvsLam`` also needs to be added here because it is declared before the transmission output and the list must always be in the same order):
+
+ ``IvsQ, IvsQ_unbinned, IvsLam, transLam = ReflectometryReductionOneAuto(InputWorkspace=run, FirstTransmissionRun=trans, ThetaIn=0.7)``
+
+ If your scripts use the output property instead then they will not be affected, e.g. calls like this will still work as before:
+
+ ``ReflectometryReductionOneAuto(InputWorkspace=run, FirstTransmissionRun=trans, ThetaIn=0.7, OutputWorkspaceBinned='ivsq_bin')``
+
Bug fixes
---------
diff --git a/docs/source/release/v4.3.0/sans.rst b/docs/source/release/v4.3.0/sans.rst
index ed9b86138e11aff4e4ea2e26e0f4768602349869..883dd05559202de41a06e1d12aea76430d8fd306 100644
--- a/docs/source/release/v4.3.0/sans.rst
+++ b/docs/source/release/v4.3.0/sans.rst
@@ -16,10 +16,31 @@ Improved
- :ref:`MaskBTP <algm-MaskBTP>` now handles both old and new instrument definitions for BIOSANS and GPSANS
- :ref:`SANSILLReduction <algm-SANSILLReduction>` and :ref:`SANSILLAutoProcess <algm-SANSILLAutoProcess>` are improved to better handle the absolute scale normalisation.
- :ref:`SANSILLIntegration <algm-SANSILLIntegration>` will now offer to produce I(Q) for separate detector components separately, which is useful for D33.
+- :ref:`SANSILLReduction <algm-SANSILLReduction>` will now allow for correct absolute scale normalisation even in circumstances when, for example, there is no flux measurement for the water run configuration.
- Data with invalid proton charge logs will now be fixed before performing
slicing. A warning is emitted when this happens.
- ISIS SANS history for top level algorithms now works correctly. A user
can copy the history of a workspace to their clipboard or a file and the data
will be reproduced on that machine without requiring editing of the script.
+- Batch CSV files can have their columns in any order and will load into
+ the SANS GUI correctly.
+
+Fixed
+#####
+- Tabbing between columns has been improved in the data GUI table. Users
+ can now single tab between unmodified columns, or double tab for modified.
+- Saving a CSV with sample geometry enabled, then reloading works correctly.
+- Hitting Shift+Enter on the top row no longer causes an exception
+
+Changes
+#######
+- Sample periods and geometry inputs have been move to the right of the table,
+ as part of the tabbing improvements.
+
+Fixed
+#####
+- A zero monitor shift did not previously account for the position
+ of the rear detector for Zoom. A 0.0mm offset now works correctly when
+ processing data from the SANS GUI or command interface.
:ref:`Release 4.3.0 <v4.3.0>`
diff --git a/qt/applications/workbench/workbench/app/mainwindow.py b/qt/applications/workbench/workbench/app/mainwindow.py
index 6127053932c34e65a9efa257354eb02eedb28de8..a69b08fc0544b11b5dc5b62439718cc9eb507474 100644
--- a/qt/applications/workbench/workbench/app/mainwindow.py
+++ b/qt/applications/workbench/workbench/app/mainwindow.py
@@ -244,6 +244,10 @@ class MainWindow(QMainWindow):
self.workspacewidget.workspacewidget.enableDeletePrompt(bool(prompt))
self.widgets.append(self.workspacewidget)
+ #set the link between the algorithm and workspace widget
+ self.algorithm_selector.algorithm_selector.set_get_selected_workspace_fn(
+ self.workspacewidget.workspacewidget.getSelectedWorkspaceNames)
+
# Set up the project, recovery and interface manager objects
self.project = Project(GlobalFigureManager, find_all_windows_that_are_savable)
self.project_recovery = ProjectRecovery(globalfiguremanager=GlobalFigureManager,
@@ -425,8 +429,7 @@ class MainWindow(QMainWindow):
"""Return a dictionary mapping a category to a set of named Python interfaces"""
items = ConfigService['mantidqt.python_interfaces'].split()
# list of custom interfaces that are not qt4/qt5 compatible
- GUI_BLACKLIST = ['ISIS_Reflectometry_Old.py',
- 'Frequency_Domain_Analysis_Old.py']
+ GUI_BLACKLIST = ['Frequency_Domain_Analysis_Old.py']
# detect the python interfaces
interfaces = {}
diff --git a/qt/applications/workbench/workbench/config/__init__.py b/qt/applications/workbench/workbench/config/__init__.py
index 942ba61e3a51b96ed3590c21a6203d6ae55e2395..73413419bcb2cfb509fc0a69c217533307fc6fe3 100644
--- a/qt/applications/workbench/workbench/config/__init__.py
+++ b/qt/applications/workbench/workbench/config/__init__.py
@@ -18,13 +18,16 @@ and use it to access the settings
"""
from __future__ import (absolute_import, unicode_literals)
+# std imports
+import os
+import sys
+
# third-party imports
from qtpy.QtCore import QSettings
# local imports
from .user import UserConfig
-
# -----------------------------------------------------------------------------
# Constants
# -----------------------------------------------------------------------------
@@ -32,6 +35,18 @@ ORGANIZATION = 'mantidproject'
ORG_DOMAIN = 'mantidproject.org'
APPNAME = 'mantidworkbench'
+DEFAULT_SCRIPT_CONTENT = ""
+if sys.version_info < (3, 0):
+ DEFAULT_SCRIPT_CONTENT += "# The following line helps with future compatibility with Python 3" + os.linesep + \
+ "# print must now be used as a function, e.g print('Hello','World')" + os.linesep + \
+ "from __future__ import (absolute_import, division, print_function, unicode_literals)" + \
+ os.linesep + os.linesep
+
+DEFAULT_SCRIPT_CONTENT += "# import mantid algorithms, numpy and matplotlib" + os.linesep + \
+ "from mantid.simpleapi import *" + os.linesep + \
+ "import matplotlib.pyplot as plt" + os.linesep + \
+ "import numpy as np" + os.linesep + os.linesep
+
# Iterable containing defaults for each configurable section of the code
# General application settings are in the main section
DEFAULTS = {
diff --git a/qt/applications/workbench/workbench/plotting/figureerrorsmanager.py b/qt/applications/workbench/workbench/plotting/figureerrorsmanager.py
index 72075acb0cc6c34518613218073dc0cf62e866f4..59bd2a86b8dfa41c90dfab30c1273d51c5d09856 100644
--- a/qt/applications/workbench/workbench/plotting/figureerrorsmanager.py
+++ b/qt/applications/workbench/workbench/plotting/figureerrorsmanager.py
@@ -11,8 +11,8 @@ Controls the dynamic displaying of errors for line on the plot
from matplotlib.container import ErrorbarContainer
from matplotlib.lines import Line2D
-from mantid.plots import helperfunctions, MantidAxes
-from mantid.plots.helperfunctions import get_data_from_errorbar_container, set_errorbars_hidden
+from mantid.plots import datafunctions, MantidAxes
+from mantid.plots.datafunctions import get_data_from_errorbar_container, set_errorbars_hidden
from mantid.plots.legend import LegendProperties
from mantidqt.widgets.plotconfigdialog.curvestabwidget import curve_has_errors, CurveProperties, remove_curve_from_ax
@@ -51,14 +51,14 @@ class FigureErrorsManager(object):
new_curve = cls.replot_curve(ax, curve, plot_kwargs)
if isinstance(ax, MantidAxes):
- errorbar_cap_lines = helperfunctions.remove_and_return_errorbar_cap_lines(ax)
+ errorbar_cap_lines = datafunctions.remove_and_return_errorbar_cap_lines(ax)
else:
errorbar_cap_lines = []
ax.lines.insert(curve_index, ax.lines.pop())
if isinstance(ax, MantidAxes) and ax.is_waterfall():
- helperfunctions.convert_single_line_to_waterfall(ax, curve_index)
+ datafunctions.convert_single_line_to_waterfall(ax, curve_index)
ax.lines += errorbar_cap_lines
diff --git a/qt/applications/workbench/workbench/plotting/figureinteraction.py b/qt/applications/workbench/workbench/plotting/figureinteraction.py
index 5ddb9e7ca4ccc33af196a01d94c0d049564298be..b88bbe36cfc53d018a77986d3384ac33ccf2d19a 100644
--- a/qt/applications/workbench/workbench/plotting/figureinteraction.py
+++ b/qt/applications/workbench/workbench/plotting/figureinteraction.py
@@ -24,7 +24,7 @@ from matplotlib.collections import Collection
# third party imports
from mantid.api import AnalysisDataService as ads
-from mantid.plots import helperfunctions, MantidAxes
+from mantid.plots import datafunctions, MantidAxes
from mantid.plots.utility import zoom, MantidAxType
from mantid.py3compat import iteritems
from mantidqt.plotting.figuretype import FigureType, figure_type
@@ -691,7 +691,7 @@ class FigureInteraction(object):
ax.autoscale()
if waterfall:
- helperfunctions.set_initial_dimensions(ax)
+ datafunctions.set_initial_dimensions(ax)
ax.update_waterfall(x, y)
self.canvas.draw()
@@ -736,5 +736,5 @@ class FigureInteraction(object):
for ax in self.canvas.figure.get_axes():
images = ax.get_images() + [col for col in ax.collections if isinstance(col, Collection)]
for image in images:
- helperfunctions.update_colorbar_scale(self.canvas.figure, image, scale_type, image.norm.vmin, image.norm.vmax)
+ datafunctions.update_colorbar_scale(self.canvas.figure, image, scale_type, image.norm.vmin, image.norm.vmax)
self.canvas.draw_idle()
diff --git a/qt/applications/workbench/workbench/plotting/figuremanager.py b/qt/applications/workbench/workbench/plotting/figuremanager.py
index 9584265543f75256366c36a8b5042c90ba3d70e0..b35482837e5275e3944e14f352fdcf1de4467336 100644
--- a/qt/applications/workbench/workbench/plotting/figuremanager.py
+++ b/qt/applications/workbench/workbench/plotting/figuremanager.py
@@ -23,7 +23,7 @@ from qtpy.QtWidgets import QApplication, QLabel, QFileDialog
from mantid.api import AnalysisDataService, AnalysisDataServiceObserver, ITableWorkspace, MatrixWorkspace
from mantid.kernel import logger
-from mantid.plots import helperfunctions, MantidAxes
+from mantid.plots import datafunctions, MantidAxes
from mantid.py3compat import text_type
from mantidqt.io import open_a_file_dialog
from mantidqt.plotting.figuretype import FigureType, figure_type
@@ -418,10 +418,10 @@ class FigureManagerWorkbench(FigureManagerBase, QObject):
def waterfall_reverse_line_order(self):
ax = self.canvas.figure.get_axes()[0]
x, y = ax.waterfall_x_offset, ax.waterfall_y_offset
- fills = helperfunctions.get_waterfall_fills(ax)
+ fills = datafunctions.get_waterfall_fills(ax)
ax.update_waterfall(0, 0)
- errorbar_cap_lines = helperfunctions.remove_and_return_errorbar_cap_lines(ax)
+ errorbar_cap_lines = datafunctions.remove_and_return_errorbar_cap_lines(ax)
ax.lines.reverse()
ax.lines += errorbar_cap_lines
diff --git a/qt/applications/workbench/workbench/plotting/plotscriptgenerator/__init__.py b/qt/applications/workbench/workbench/plotting/plotscriptgenerator/__init__.py
index b45a16d299461660fdf7a8b476c652aaba0058f6..ba482bbe17bcba157e015fa9dd7a76bcc86a9d60 100644
--- a/qt/applications/workbench/workbench/plotting/plotscriptgenerator/__init__.py
+++ b/qt/applications/workbench/workbench/plotting/plotscriptgenerator/__init__.py
@@ -8,11 +8,11 @@
from __future__ import (absolute_import, unicode_literals)
-from mantid.plots import MantidAxes
+from mantid.plots.mantidaxes import MantidAxes
from mantidqt.widgets.plotconfigdialog import curve_in_ax
from matplotlib.legend import Legend
-from workbench.plugins.editor import DEFAULT_CONTENT
+from workbench.config import DEFAULT_SCRIPT_CONTENT
from workbench.plotting.plotscriptgenerator.axes import (generate_axis_limit_commands,
generate_axis_label_commands,
generate_set_title_command,
@@ -67,7 +67,7 @@ def generate_script(fig, exclude_headers=False):
if not plot_commands:
return
- cmds = [] if exclude_headers else [DEFAULT_CONTENT]
+ cmds = [] if exclude_headers else [DEFAULT_SCRIPT_CONTENT]
cmds.extend(generate_workspace_retrieval_commands(fig) + [''])
cmds.append("{}, {} = {}".format(FIG_VARIABLE, AXES_VARIABLE, generate_subplots_command(fig)))
cmds.extend(plot_commands)
diff --git a/qt/applications/workbench/workbench/plotting/plotscriptgenerator/lines.py b/qt/applications/workbench/workbench/plotting/plotscriptgenerator/lines.py
index 356817d7ff4f458469c949f201da1436d153f9fc..8659ca1262c026bdb519556cc9ce807f06814a35 100644
--- a/qt/applications/workbench/workbench/plotting/plotscriptgenerator/lines.py
+++ b/qt/applications/workbench/workbench/plotting/plotscriptgenerator/lines.py
@@ -12,7 +12,7 @@ from matplotlib import rcParams
from matplotlib.container import ErrorbarContainer
from mantid.kernel import config
-from mantid.plots.helperfunctions import errorbars_hidden
+from mantid.plots.datafunctions import errorbars_hidden
from mantidqt.widgets.plotconfigdialog.curvestabwidget import CurveProperties, get_ax_from_curve
from workbench.plotting.plotscriptgenerator.utils import convert_args_to_string, clean_variable_name
diff --git a/qt/applications/workbench/workbench/plotting/propertiesdialog.py b/qt/applications/workbench/workbench/plotting/propertiesdialog.py
index 24a45bb9eb5637315c92550788b0b0f88ad6cd8f..a39b5c45d7380e779aa771f6fabb9399d411daaa 100644
--- a/qt/applications/workbench/workbench/plotting/propertiesdialog.py
+++ b/qt/applications/workbench/workbench/plotting/propertiesdialog.py
@@ -12,7 +12,7 @@ from __future__ import (absolute_import, unicode_literals)
# std imports
# 3rdparty imports
-from mantid.plots.helperfunctions import update_colorbar_scale
+from mantid.plots.datafunctions import update_colorbar_scale
from mantidqt.plotting.figuretype import FigureType, figure_type
from mantidqt.utils.qt import load_ui
from matplotlib.collections import QuadMesh
@@ -133,7 +133,11 @@ class AxisEditor(PropertiesEditorBase):
self._memento = memento
memento.min, memento.max = getattr(self.axes, 'get_{}lim'.format(self.axis_id))()
memento.log = getattr(self.axes, 'get_{}scale'.format(self.axis_id))() != 'linear'
- memento.grid = self.axis.majorTicks[0].gridOn
+ ticks = self.axis.majorTicks[0]
+ if hasattr(ticks,"get_visible"):
+ memento.grid = ticks.get_visible()
+ else:
+ memento.grid = ticks.gridOn
self._fill(memento)
diff --git a/qt/applications/workbench/workbench/plugins/editor.py b/qt/applications/workbench/workbench/plugins/editor.py
index ff59205323db949134e09d17642ba550d42ce0d6..649061017fb7227de87e3ddadcdd3a23d14e7214 100644
--- a/qt/applications/workbench/workbench/plugins/editor.py
+++ b/qt/applications/workbench/workbench/plugins/editor.py
@@ -18,24 +18,13 @@ from qtpy.QtWidgets import QVBoxLayout
# local package imports
from mantid.kernel import logger
from mantidqt.widgets.codeeditor.multifileinterpreter import MultiPythonFileInterpreter
+from ..config import DEFAULT_SCRIPT_CONTENT
from ..config.fonts import text_font
from ..plugins.base import PluginWidget
# from mantidqt.utils.qt import toQSettings when readSettings/writeSettings are implemented
-# Initial content
-DEFAULT_CONTENT = """# The following line helps with future compatibility with Python 3
-# print must now be used as a function, e.g print('Hello','World')
-from __future__ import (absolute_import, division, print_function, unicode_literals)
-
-# import mantid algorithms, numpy and matplotlib
-from mantid.simpleapi import *
-
-import matplotlib.pyplot as plt
-
-import numpy as np
-"""
# Accepted extensions for drag-and-drop to editor
ACCEPTED_FILE_EXTENSIONS = ['.py', '.pyw']
# QSettings key for session tabs
@@ -55,7 +44,7 @@ class MultiFileEditor(PluginWidget):
# layout
self.editors = MultiPythonFileInterpreter(font=font,
- default_content=DEFAULT_CONTENT,
+ default_content=DEFAULT_SCRIPT_CONTENT,
parent=self)
layout = QVBoxLayout()
layout.addWidget(self.editors)
diff --git a/qt/python/CMakeLists.txt b/qt/python/CMakeLists.txt
index 88c5126d5b5a36a7707dafcd8bd3d410deea5967..ed31bce6b75e6ad6e8c5a6cebf4795d9fc688c3e 100644
--- a/qt/python/CMakeLists.txt
+++ b/qt/python/CMakeLists.txt
@@ -91,11 +91,6 @@ if(ENABLE_WORKBENCH OR ENABLE_WORKBENCH)
mantidqt/utils/test/test_modal_tester.py
mantidqt/utils/test/test_qt_utils.py
mantidqt/utils/test/test_writetosignal.py
- mantidqt/widgets/codeeditor/test/test_codeeditor.py
- mantidqt/widgets/codeeditor/test/test_completion.py
- mantidqt/widgets/codeeditor/test/test_errorformatter.py
- mantidqt/widgets/codeeditor/test/test_execution.py
- mantidqt/widgets/codeeditor/test/test_interpreter.py
mantidqt/widgets/test/test_messagedisplay.py
mantidqt/widgets/test/test_fitpropertybrowser.py
mantidqt/widgets/test/test_fitpropertybrowserbase.py
@@ -118,6 +113,11 @@ if(ENABLE_WORKBENCH OR ENABLE_WORKBENCH)
PYTHON_WIDGET_QT5_ONLY_TESTS
mantidqt/widgets/algorithmselector/test/observer_test.py
mantidqt/widgets/algorithmselector/test/test_algorithmselector.py
+ mantidqt/widgets/codeeditor/test/test_codeeditor.py
+ mantidqt/widgets/codeeditor/test/test_completion.py
+ mantidqt/widgets/codeeditor/test/test_execution.py
+ mantidqt/widgets/codeeditor/test/test_errorformatter.py
+ mantidqt/widgets/codeeditor/test/test_interpreter.py
mantidqt/widgets/codeeditor/test/test_interpreter_view.py
mantidqt/widgets/codeeditor/test/test_multifileinterpreter.py
mantidqt/widgets/codeeditor/test/test_multifileinterpreter_view.py
diff --git a/qt/python/mantidqt/_common.sip b/qt/python/mantidqt/_common.sip
index 84563825bc0cf80e37a56155adb377be985d6b5a..f1d428455e110feadebb6fe7c14f56143a4ba9eb 100644
--- a/qt/python/mantidqt/_common.sip
+++ b/qt/python/mantidqt/_common.sip
@@ -2,6 +2,8 @@
#include "MantidQtWidgets/Common/Message.h"
#include "MantidQtWidgets/Common/WorkspaceObserver.h"
#include "MantidPythonInterface/core/VersionCompat.h"
+#include "frameobject.h"
+
// Allows suppression of namespaces within the module
using namespace MantidQt::MantidWidgets;
using namespace MantidQt::MantidWidgets::Batch;
@@ -104,18 +106,6 @@ public:
void setSource(const QString &source);
};
-%If (Qt_5_0_0 -)
-class AlgorithmProgressWidget : QWidget {
-%TypeHeaderCode
-#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressWidget.h"
-%End
-
-public:
- AlgorithmProgressWidget(QWidget *parent /TransferThis/ = 0);
- void blockUpdates(bool block = true);
-};
-%End
-
class ScriptEditor : QWidget {
%TypeHeaderCode
#include "MantidQtWidgets/Common/ScriptEditor.h"
@@ -175,6 +165,7 @@ public:
void setSelection(int lineFrom, int indexFrom, int lineTo, int indexTo);
void setTabWidth(int width);
void setText(const QString &text);
+ void setEolVisibility(bool state);
void setWhitespaceVisibility(WhitespaceVisibility mode);
void updateCompletionAPI(const QStringList & completions);
@@ -184,8 +175,6 @@ public:
void replaceAll(const QString &search, const QString &replace,
bool regex, bool caseSensitive, bool matchWords,
bool wrap, bool backward);
-
-
public slots:
void updateProgressMarker(int lineno, bool error);
void zoomTo(int level);
@@ -200,6 +189,33 @@ private:
ScriptEditor(const ScriptEditor&);
};
+%If (Qt_5_0_0 -)
+
+class AlgorithmProgressWidget : QWidget {
+%TypeHeaderCode
+#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressWidget.h"
+%End
+
+public:
+ AlgorithmProgressWidget(QWidget *parent /TransferThis/ = 0);
+ void blockUpdates(bool block = true);
+};
+
+class CodeExecution {
+%TypeHeaderCode
+#include "MantidQtWidgets/Common/Python/CodeExecution.h"
+using MantidQt::Widgets::Common::Python::CodeExecution;
+%End
+
+public:
+ CodeExecution(ScriptEditor*);
+ SIP_PYOBJECT execute(const QString &, const QString &, int, SIP_PYOBJECT);
+private:
+ CodeExecution(const CodeExecution&);
+};
+
+%End // end >= Qt5
+
class AlgorithmDialog: QDialog {
%TypeHeaderCode
@@ -895,6 +911,7 @@ public:
QString getText();
QString getFirstFilename() const;
+ QStringList getFilenames() const;
void isForRunFiles(bool /*mode*/);
void isForDirectory(bool /*mode*/);
void allowMultipleFiles(bool /*allow*/);
diff --git a/qt/python/mantidqt/dialogs/spectraselectordialog.py b/qt/python/mantidqt/dialogs/spectraselectordialog.py
index 4f9dad8d8cf3f9b20e75f172502d6fd5428a1d20..8be9167a18c6a0a31e336337e299caa299fc47f9 100644
--- a/qt/python/mantidqt/dialogs/spectraselectordialog.py
+++ b/qt/python/mantidqt/dialogs/spectraselectordialog.py
@@ -79,6 +79,8 @@ class SpectraSelectionDialog(SpectraSelectionDialogUIBase):
self._init_ui()
self._set_placeholder_text()
self._setup_connections()
+ self._on_specnums_changed()
+ self._on_wkspindices_changed()
def on_ok_clicked(self):
if self._check_number_of_plots(self.selection):
@@ -171,6 +173,12 @@ class SpectraSelectionDialog(SpectraSelectionDialogUIBase):
self._parse_wksp_indices()
ui.wkspIndicesValid.setVisible(not self._is_input_valid())
+ if self._is_input_valid() or ui.wkspIndices.text() == "":
+ ui.wkspIndicesValid.setVisible(False)
+ ui.wkspIndicesValid.setToolTip("")
+ else:
+ ui.wkspIndicesValid.setVisible(True)
+ ui.wkspIndicesValid.setToolTip("Not in " + ui.wkspIndices.placeholderText())
ui.buttonBox.button(QDialogButtonBox.Ok).setEnabled(self._is_input_valid())
def _on_specnums_changed(self):
@@ -180,6 +188,12 @@ class SpectraSelectionDialog(SpectraSelectionDialogUIBase):
self._parse_spec_nums()
ui.specNumsValid.setVisible(not self._is_input_valid())
+ if self._is_input_valid() or ui.specNums.text() == "":
+ ui.specNumsValid.setVisible(False)
+ ui.specNumsValid.setToolTip("")
+ else:
+ ui.specNumsValid.setVisible(True)
+ ui.specNumsValid.setToolTip("Not in " + ui.specNums.placeholderText())
ui.buttonBox.button(QDialogButtonBox.Ok).setEnabled(self._is_input_valid())
def _on_plot_type_changed(self, new_index):
diff --git a/qt/python/mantidqt/plotting/functions.py b/qt/python/mantidqt/plotting/functions.py
index dda58a89621f10af02bb112f7cfe7a62235c2f4d..0c9f5dd4feeb5fe54191d381ae9254fcf2d3e451 100644
--- a/qt/python/mantidqt/plotting/functions.py
+++ b/qt/python/mantidqt/plotting/functions.py
@@ -12,8 +12,6 @@ our custom window.
"""
# std imports
-import collections
-import math
import numpy as np
# 3rd party imports
@@ -21,20 +19,17 @@ try:
from matplotlib.cm import viridis as DEFAULT_CMAP
except ImportError:
from matplotlib.cm import jet as DEFAULT_CMAP
-from matplotlib.gridspec import GridSpec
-from matplotlib.legend import Legend
# local imports
from mantid.api import AnalysisDataService, MatrixWorkspace
-from mantid.kernel import Logger, ConfigService
-from mantid.plots import helperfunctions, MantidAxes
+from mantid.kernel import Logger
+from mantid.plots.plotfunctions import manage_workspace_names, figure_title, plot,\
+ create_subplots,raise_if_not_sequence
from mantidqt.plotting.figuretype import figure_type, FigureType
-from mantid.py3compat import is_text_string, string_types
from mantidqt.dialogs.spectraselectorutils import get_spectra_selection
# -----------------------------------------------------------------------------
# Constants
# -----------------------------------------------------------------------------
-PROJECTION = 'mantid'
# See https://matplotlib.org/api/_as_gen/matplotlib.figure.SubplotParams.html#matplotlib.figure.SubplotParams
SUBPLOT_WSPACE = 0.5
SUBPLOT_HSPACE = 0.5
@@ -42,44 +37,11 @@ COLORPLOT_MIN_WIDTH = 8
COLORPLOT_MIN_HEIGHT = 7
LOGGER = Logger("workspace.plotting.functions")
-MARKER_MAP = {'square': 's', 'plus (filled)': 'P', 'point': '.', 'tickdown': 3,
- 'triangle_right': '>', 'tickup': 2, 'hline': '_', 'vline': '|',
- 'pentagon': 'p', 'tri_left': '3', 'caretdown': 7,
- 'caretright (centered at base)': 9, 'tickright': 1,
- 'caretright': 5, 'caretleft': 4, 'tickleft': 0, 'tri_up': '2',
- 'circle': 'o', 'pixel': ',', 'caretleft (centered at base)': 8,
- 'diamond': 'D', 'star': '*', 'hexagon1': 'h', 'octagon': '8',
- 'hexagon2': 'H', 'tri_right': '4', 'x (filled)': 'X',
- 'thin_diamond': 'd', 'tri_down': '1', 'triangle_left': '<',
- 'plus': '+', 'triangle_down': 'v', 'triangle_up': '^', 'x': 'x',
- 'caretup': 6, 'caretup (centered at base)': 10,
- 'caretdown (centered at base)': 11, 'None': 'None'}
-
-
-# -----------------------------------------------------------------------------
-# Decorators
-# -----------------------------------------------------------------------------
-
-def manage_workspace_names(func):
- """
- A decorator to go around plotting functions.
- This will retrieve workspaces from workspace names before
- calling the plotting function
- :param func: A plotting function
- :return:
- """
-
- def inner_func(workspaces, *args, **kwargs):
- workspaces = _validate_workspace_names(workspaces)
- return func(workspaces, *args, **kwargs)
-
- return inner_func
-
-
# -----------------------------------------------------------------------------
# 'Public' Functions
# -----------------------------------------------------------------------------
+
def can_overplot():
"""
Checks if overplotting on the current figure can proceed
@@ -113,29 +75,6 @@ def current_figure_or_none():
return None
-def figure_title(workspaces, fig_num):
- """Create a default figure title from a single workspace, list of workspaces or
- workspace names and a figure number. The name of the first workspace in the list
- is concatenated with the figure number.
-
- :param workspaces: A single workspace, list of workspaces or workspace name/list of workspace names
- :param fig_num: An integer denoting the figure number
- :return: A title for the figure
- """
-
- def wsname(w):
- return w.name() if hasattr(w, 'name') else w
-
- if is_text_string(workspaces) or not isinstance(workspaces, collections.Sequence):
- # assume a single workspace
- first = workspaces
- else:
- assert len(workspaces) > 0
- first = workspaces[0]
-
- return wsname(first) + '-' + str(fig_num)
-
-
def plot_from_names(names, errors, overplot, fig=None, show_colorfill_btn=False):
"""
Given a list of names of workspaces, raise a dialog asking for the
@@ -166,179 +105,6 @@ def plot_from_names(names, errors, overplot, fig=None, show_colorfill_btn=False)
waterfall=selection.plot_type==selection.Waterfall)
-def get_plot_fig(overplot=None, ax_properties=None, window_title=None, axes_num=1, fig=None):
- """
- Create a blank figure and axes, with configurable properties.
- :param overplot: If true then plotting on figure will plot over previous plotting. If an axis object the overplotting
- will be done on the axis passed in
- :param ax_properties: A dict of axes properties. E.g. {'yscale': 'log'} for log y-axis
- :param window_title: A string denoting the name of the GUI window which holds the graph
- :param axes_num: The number of axes to create on the figure
- :param fig: An optional figure object
- :return: Matplotlib fig and axes objects
- """
- import matplotlib.pyplot as plt
- if fig and overplot:
- fig = fig
- elif fig:
- fig, _, _, _ = _create_subplots(axes_num, fig)
- elif overplot:
- fig = plt.gcf()
- else:
- fig, _, _, _ = _create_subplots(axes_num)
-
- if not ax_properties:
- ax_properties = {}
- if ConfigService.getString("plots.xAxesScale").lower() == 'log':
- ax_properties['xscale'] = 'log'
- else:
- ax_properties['xscale'] = 'linear'
- if ConfigService.getString("plots.yAxesScale").lower() == 'log':
- ax_properties['yscale'] = 'log'
- else:
- ax_properties['yscale'] = 'linear'
- if ax_properties:
- for axis in fig.axes:
- axis.set(**ax_properties)
- if window_title:
- fig.canvas.set_window_title(window_title)
-
- return fig, fig.axes
-
-
-@manage_workspace_names
-def plot(workspaces, spectrum_nums=None, wksp_indices=None, errors=False,
- overplot=False, fig=None, plot_kwargs=None, ax_properties=None,
- window_title=None, tiled=False, waterfall=False):
- """
- Create a figure with a single subplot and for each workspace/index add a
- line plot to the new axes. show() is called before returning the figure instance. A legend
- is added.
-
- :param workspaces: A list of workspace handles or strings
- :param spectrum_nums: A list of spectrum number identifiers (general start from 1)
- :param wksp_indices: A list of workspace indexes (starts from 0)
- :param errors: If true then error bars are added for each plot
- :param overplot: If true then overplot over the current figure if one exists. If an axis object the overplotting
- will be done on the axis passed in
- :param fig: If not None then use this Figure object to plot
- :param plot_kwargs: Arguments that will be passed onto the plot function
- :param ax_properties: A dict of axes properties. E.g. {'yscale': 'log'}
- :param window_title: A string denoting name of the GUI window which holds the graph
- :param tiled: An optional flag controlling whether to do a tiled or overlayed plot
- :param waterfall: An optional flag controlling whether or not to do a waterfall plot
- :return: The figure containing the plots
- """
- if plot_kwargs is None:
- plot_kwargs = {}
- _validate_plot_inputs(workspaces, spectrum_nums, wksp_indices, tiled, overplot)
- workspaces = [ws for ws in workspaces if isinstance(ws, MatrixWorkspace)]
-
- if spectrum_nums is not None:
- kw, nums = 'specNum', spectrum_nums
- else:
- kw, nums = 'wkspIndex', wksp_indices
-
- _add_default_plot_kwargs_from_settings(plot_kwargs, errors)
-
- num_axes = len(workspaces) * len(nums) if tiled else 1
-
- fig, axes = get_plot_fig(overplot, ax_properties, window_title, num_axes, fig)
-
- # Convert to a MantidAxes if it isn't already. Ignore legend since
- # a new one will be drawn later
- axes = [MantidAxes.from_mpl_axes(ax, ignore_artists=[Legend]) if not isinstance(ax, MantidAxes) else ax
- for ax in axes]
-
- if tiled:
- ws_index = [(ws, index) for ws in workspaces for index in nums]
- for index, ax in enumerate(axes):
- if index < len(ws_index):
- _do_single_plot(ax, [ws_index[index][0]], errors, False, [ws_index[index][1]], kw, plot_kwargs)
- else:
- ax.axis('off')
- else:
- show_title = ("on" == ConfigService.getString("plots.ShowTitle").lower()) and not overplot
- ax = overplot if isinstance(overplot, MantidAxes) else axes[0]
- ax.axis('on')
- _do_single_plot(ax, workspaces, errors, show_title, nums, kw, plot_kwargs)
-
- # Can't have a waterfall plot with only one line.
- if len(nums)*len(workspaces) == 1 and waterfall:
- waterfall = False
-
- # The plot's initial xlim and ylim are used to offset each curve in a waterfall plot.
- # Need to do this whether the current curve is a waterfall plot or not because it may be converted later.
- if not overplot:
- helperfunctions.set_initial_dimensions(ax)
-
- if waterfall:
- ax.set_waterfall(True)
-
- if not overplot:
- fig.canvas.set_window_title(figure_title(workspaces, fig.number))
- else:
- if ax.is_waterfall():
- for i in range(len(nums)*len(workspaces)):
- errorbar_cap_lines = helperfunctions.remove_and_return_errorbar_cap_lines(ax)
- helperfunctions.convert_single_line_to_waterfall(ax, len(ax.get_lines())-(i+1))
-
- if ax.waterfall_has_fill():
- helperfunctions.waterfall_update_fill(ax)
-
- ax.lines += errorbar_cap_lines
-
- # This updates the toolbar so the home button now takes you back to this point.
- # The try catch is in case the manager does not have a toolbar attached.
- try:
- fig.canvas.manager.toolbar.update()
- except AttributeError:
- pass
-
- fig.canvas.draw()
- # This displays the figure, but only works if a manager is attached to the figure.
- # The try catch is in case a figure manager is not present
- try:
- fig.show()
- except AttributeError:
- pass
-
- return fig
-
-
-def _add_default_plot_kwargs_from_settings(plot_kwargs, errors):
- if 'linestyle' not in plot_kwargs:
- plot_kwargs['linestyle'] = ConfigService.getString("plots.line.Style")
- if 'linewidth' not in plot_kwargs:
- plot_kwargs['linewidth'] = float(ConfigService.getString("plots.line.Width"))
- if 'marker' not in plot_kwargs:
- plot_kwargs['marker'] = MARKER_MAP[ConfigService.getString("plots.marker.Style")]
- if 'markersize' not in plot_kwargs:
- plot_kwargs['markersize'] = float(ConfigService.getString("plots.marker.Size"))
- if errors:
- if 'capsize' not in plot_kwargs:
- plot_kwargs['capsize'] = float(ConfigService.getString("plots.errorbar.Capsize"))
- if 'capthick' not in plot_kwargs:
- plot_kwargs['capthick'] = float(ConfigService.getString("plots.errorbar.CapThickness"))
- if 'errorevery' not in plot_kwargs:
- plot_kwargs['errorevery'] = int(ConfigService.getString("plots.errorbar.errorEvery"))
- if 'elinewidth' not in plot_kwargs:
- plot_kwargs['elinewidth'] = float(ConfigService.getString("plots.errorbar.Width"))
-
-
-def _do_single_plot(ax, workspaces, errors, set_title, nums, kw, plot_kwargs):
- # do the plotting
- plot_fn = ax.errorbar if errors else ax.plot
- for ws in workspaces:
- for num in nums:
- plot_kwargs[kw] = num
- plot_fn(ws, **plot_kwargs)
- ax.make_legend()
- if set_title:
- title = workspaces[0].name()
- ax.set_title(title)
-
-
def pcolormesh_from_names(names, fig=None, ax=None):
"""
Create a figure containing pcolor subplots
@@ -388,7 +154,7 @@ def pcolormesh(workspaces, fig=None):
# create a subplot of the appropriate number of dimensions
# extend in number of columns if the number of plottables is not a square number
workspaces_len = len(workspaces)
- fig, axes, nrows, ncols = _create_subplots(workspaces_len, fig=fig)
+ fig, axes, nrows, ncols = create_subplots(workspaces_len, fig=fig)
row_idx, col_idx = 0, 0
for subplot_idx in range(nrows * ncols):
@@ -436,142 +202,7 @@ def pcolormesh_on_axis(ax, ws):
return pcm
-# ----------------- Compatability functions ---------------------
-
-
-def plotSpectrum(workspaces, indices, distribution=None, error_bars=False,
- type=None, window=None, clearWindow=None,
- waterfall=False):
- """
- Create a figure with a single subplot and for each workspace/index add a
- line plot to the new axes. show() is called before returning the figure instance
-
- :param workspaces: Workspace/workspaces to plot as a string, workspace handle, list of strings or list of
- workspaces handles.
- :param indices: A single int or list of ints specifying the workspace indices to plot
- :param distribution: ``None`` (default) asks the workspace. ``False`` means
- divide by bin width. ``True`` means do not divide by bin width.
- Applies only when the the workspace is a MatrixWorkspace histogram.
- :param error_bars: If true then error bars will be added for each curve
- :param type: curve style for plot (-1: unspecified; 0: line, default; 1: scatter/dots)
- :param window: Ignored. Here to preserve backwards compatibility
- :param clearWindow: Ignored. Here to preserve backwards compatibility
- :param waterfall:
- """
- if type == 1:
- fmt = 'o'
- else:
- fmt = '-'
-
- return plot(workspaces, wksp_indices=indices,
- errors=error_bars, fmt=fmt)
-
-
-# -----------------------------------------------------------------------------
-# 'Private' Functions
-# -----------------------------------------------------------------------------
-def _raise_if_not_sequence(value, seq_name, element_type=None):
- """
- Raise a ValueError if the given object is not a sequence
-
- :param value: The value object to validate
- :param seq_name: The variable name of the sequence for the error message
- :param element_type: An optional type to provide to check that each element
- is an instance of this type
- :raises ValueError: if the conditions are not met
- """
- accepted_types = (list, tuple, range)
- if type(value) not in accepted_types:
- raise ValueError("{} should be a list or tuple, "
- "instead found '{}'".format(seq_name,
- value.__class__.__name__))
- if element_type is not None:
- def raise_if_not_type(x):
- if not isinstance(x, element_type):
- if element_type == MatrixWorkspace:
- # If the workspace is the wrong type, log the error and remove it from the list so that the other
- # workspaces can still be plotted.
- LOGGER.warning("{} has unexpected type '{}'".format(x, x.__class__.__name__))
- else:
- raise ValueError("Unexpected type: '{}'".format(x.__class__.__name__))
-
- # Map in Python3 is an iterator, so ValueError will not be raised unless the values are yielded.
- # converting to a list forces yielding
- list(map(raise_if_not_type, value))
-
-
-def _validate_plot_inputs(workspaces, spectrum_nums, wksp_indices, tiled=False, overplot=False):
- """Raises a ValueError if any arguments have the incorrect types"""
- if spectrum_nums is not None and wksp_indices is not None:
- raise ValueError("Both spectrum_nums and wksp_indices supplied. "
- "Please supply only 1.")
-
- if tiled and overplot:
- raise ValueError("Both tiled and overplot flags set to true. "
- "Please set only one to true.")
-
- _raise_if_not_sequence(workspaces, 'workspaces', MatrixWorkspace)
-
- if spectrum_nums is not None:
- _raise_if_not_sequence(spectrum_nums, 'spectrum_nums')
-
- if wksp_indices is not None:
- _raise_if_not_sequence(wksp_indices, 'wksp_indices')
-
-
-def _validate_workspace_names(workspaces):
- """
- Checks if the workspaces passed into a plotting function are workspace names, and
- retrieves the workspaces if they are.
- This function assumes that we do not have a mix of workspaces and workspace names.
- :param workspaces: A list of workspaces or workspace names
- :return: A list of workspaces
- """
- try:
- _raise_if_not_sequence(workspaces, 'workspaces', string_types)
- except ValueError:
- return workspaces
- else:
- return AnalysisDataService.Instance().retrieveWorkspaces(workspaces, unrollGroups=True)
-
def _validate_pcolormesh_inputs(workspaces):
"""Raises a ValueError if any arguments have the incorrect types"""
- _raise_if_not_sequence(workspaces, 'workspaces', MatrixWorkspace)
-
-
-def _create_subplots(nplots, fig=None):
- """
- Create a set of subplots suitable for a given number of plots. A stripped down
- version of plt.subplots that can accept an existing figure instance.
-
- :param nplots: The number of plots required
- :param fig: An optional figure. It is cleared before plotting the new contents
- :return: A 2-tuple of (fig, axes)
- """
- import matplotlib.pyplot as plt
- square_side_len = int(math.ceil(math.sqrt(nplots)))
- nrows, ncols = square_side_len, square_side_len
- if square_side_len * square_side_len != nplots:
- # not a square number - square_side_len x square_side_len
- # will be large enough but we could end up with an empty
- # row so chop that off
- if nplots <= (nrows - 1) * ncols:
- nrows -= 1
-
- if fig is None:
- fig = plt.figure()
- else:
- fig.clf()
- # annoyling this repl
- nplots = nrows * ncols
- gs = GridSpec(nrows, ncols)
- axes = np.empty(nplots, dtype=object)
- ax0 = fig.add_subplot(gs[0, 0], projection=PROJECTION)
- axes[0] = ax0
- for i in range(1, nplots):
- axes[i] = fig.add_subplot(gs[i // ncols, i % ncols],
- projection=PROJECTION)
- axes = axes.reshape(nrows, ncols)
-
- return fig, axes, nrows, ncols
+ raise_if_not_sequence(workspaces, 'workspaces', MatrixWorkspace)
diff --git a/qt/python/mantidqt/plotting/test/test_tiledplots.py b/qt/python/mantidqt/plotting/test/test_tiledplots.py
index df285c03213ad8c59a72442cf3267ce611d16d9a..6d9c331e12213fd64593831a9bac077e1716c4da 100644
--- a/qt/python/mantidqt/plotting/test/test_tiledplots.py
+++ b/qt/python/mantidqt/plotting/test/test_tiledplots.py
@@ -24,7 +24,8 @@ import mantid.plots # noqa
from mantid.api import AnalysisDataService, WorkspaceFactory
from mantid.py3compat import mock
from mantidqt.dialogs.spectraselectordialog import SpectraSelection
-from mantidqt.plotting.functions import (manage_workspace_names, plot_from_names, get_plot_fig)
+from mantid.plots.plotfunctions import manage_workspace_names, get_plot_fig
+from mantidqt.plotting.functions import plot_from_names
# Avoid importing the whole of mantid for a single mock of the workspace class
diff --git a/qt/python/mantidqt/project/test/test_plotsloader.py b/qt/python/mantidqt/project/test/test_plotsloader.py
index e0b24f4175934f80350caf491315b7a627a984d8..d6dfba8c7bcf1ec434795d05aba0f4d61c5ce730 100644
--- a/qt/python/mantidqt/project/test/test_plotsloader.py
+++ b/qt/python/mantidqt/project/test/test_plotsloader.py
@@ -17,7 +17,7 @@ import matplotlib.figure # noqa
import matplotlib.text # noqa
from mantidqt.project.plotsloader import PlotsLoader # noqa
-import mantid.plots.plotfunctions # noqa
+import mantid.plots.axesfunctions # noqa
from mantid.api import AnalysisDataService as ADS # noqa
from mantid.dataobjects import Workspace2D # noqa
from mantid.py3compat import mock # noqa
@@ -31,7 +31,7 @@ class PlotsLoaderTest(unittest.TestCase):
def setUp(self):
self.plots_loader = PlotsLoader()
plt.plot = mock.MagicMock()
- mantid.plots.plotfunctions.plot = mock.MagicMock()
+ mantid.plots.axesfunctions.plot = mock.MagicMock()
self.dictionary = {u'legend': {u'exists': False}, u'lines': [],
u'properties': {u'axisOn': True, u'bounds': (0.0, 0.0, 0.0, 0.0), u'dynamic': True,
u'frameOn': True, u'visible': True,
diff --git a/qt/python/mantidqt/widgets/algorithmselector/model.py b/qt/python/mantidqt/widgets/algorithmselector/model.py
index bbd2b47b44d73708ea0a7cda3c60d620ef785f1d..08e2cdd23b3b23206b1a438e53dd327af4d4ecd7 100644
--- a/qt/python/mantidqt/widgets/algorithmselector/model.py
+++ b/qt/python/mantidqt/widgets/algorithmselector/model.py
@@ -6,7 +6,8 @@
# SPDX - License - Identifier: GPL - 3.0 +
from __future__ import absolute_import, print_function
-from mantid.api import AlgorithmFactory
+from mantid.api import AlgorithmFactory, AlgorithmManager, IWorkspaceProperty
+from mantid.kernel import Direction
CATEGORY_SEP = '\\'
@@ -81,3 +82,12 @@ class AlgorithmSelectorModel(object):
unique_alg_names = set(descr.name
for descr in algm_factory.getDescriptors(True))
return sorted(unique_alg_names), data
+
+ def find_input_workspace_property(self, algorithm):
+ algm_manager = AlgorithmManager.Instance()
+ alg_instance = algm_manager.createUnmanaged(algorithm[0], algorithm[1])
+ alg_instance.initialize()
+ for prop in alg_instance.getProperties():
+ if isinstance(prop, IWorkspaceProperty) and prop.direction in [Direction.Input, Direction.InOut]:
+ return prop.name
+ return None
diff --git a/qt/python/mantidqt/widgets/algorithmselector/presenter.py b/qt/python/mantidqt/widgets/algorithmselector/presenter.py
index e62bc37f326a2e80fa1437501c0df38733f1012b..96ab53fb30233ad389c1ab985afeb3036e6a7f5c 100644
--- a/qt/python/mantidqt/widgets/algorithmselector/presenter.py
+++ b/qt/python/mantidqt/widgets/algorithmselector/presenter.py
@@ -58,3 +58,6 @@ class AlgorithmSelectorPresenter(object):
def refresh(self):
algorithm_data = self.model.get_algorithm_data()
self.view.populate_ui(algorithm_data)
+
+ def find_input_workspace_property(self, algorithm):
+ return self.model.find_input_workspace_property(algorithm)
diff --git a/qt/python/mantidqt/widgets/algorithmselector/test/test_algorithmselector.py b/qt/python/mantidqt/widgets/algorithmselector/test/test_algorithmselector.py
index 22a7d72f3891c3e42a00335ebf7956289cf55313..25c34998320bf151e7d73b346005afbdf327e69d 100644
--- a/qt/python/mantidqt/widgets/algorithmselector/test/test_algorithmselector.py
+++ b/qt/python/mantidqt/widgets/algorithmselector/test/test_algorithmselector.py
@@ -162,14 +162,14 @@ class WidgetTest(unittest.TestCase):
widget = AlgorithmSelectorWidget()
self._select_in_tree(widget, 'DoStuff v.2')
widget.execute_button.click()
- createDialog.assert_called_once_with('DoStuff', 2)
+ createDialog.assert_called_once_with('DoStuff', 2, None, False, {}, '', [])
def test_run_dialog_opens_on_return_press(self):
with patch(createDialogFromName_func_name) as createDialog:
widget = AlgorithmSelectorWidget()
self._select_in_tree(widget, 'DoStuff v.2')
QTest.keyClick(widget.search_box, Qt.Key_Return)
- createDialog.assert_called_once_with('DoStuff', 2)
+ createDialog.assert_called_once_with('DoStuff', 2, None, False, {}, '', [])
def test_run_dialog_opens_on_double_click(self):
with patch(createDialogFromName_func_name) as createDialog:
@@ -179,7 +179,7 @@ class WidgetTest(unittest.TestCase):
item_pos = widget.tree.visualItemRect(selected_item).center()
QTest.mouseDClick(widget.tree.viewport(), Qt.LeftButton,
Qt.NoModifier, pos=item_pos)
- createDialog.assert_called_once_with('Load', 1)
+ createDialog.assert_called_once_with('Load', 1, None, False, {}, '', [])
def test_sorting_of_algorithms(self):
widget = AlgorithmSelectorWidget()
diff --git a/qt/python/mantidqt/widgets/algorithmselector/widget.py b/qt/python/mantidqt/widgets/algorithmselector/widget.py
index c045540ea589d5aa3f914c61c09e0cca6a4732e8..cbac577aabb96afd6827c4335aa29ab544e865d3 100644
--- a/qt/python/mantidqt/widgets/algorithmselector/widget.py
+++ b/qt/python/mantidqt/widgets/algorithmselector/widget.py
@@ -46,9 +46,10 @@ class AlgorithmTreeWidget(QTreeWidget):
def mouseDoubleClickEvent(self, mouse_event):
if mouse_event.button() == Qt.LeftButton:
- if self.selectedItems() and not self.selectedItems()[0].child(0):
+ if self.selectedItems() and get_name_and_version_from_item_label(self.selectedItems()[0].text(0)):
self.parent.execute_algorithm()
- super(AlgorithmTreeWidget, self).mouseDoubleClickEvent(mouse_event)
+ else:
+ super(AlgorithmTreeWidget, self).mouseDoubleClickEvent(mouse_event)
class AlgorithmSelectorWidget(IAlgorithmSelectorView, QWidget):
@@ -66,11 +67,15 @@ class AlgorithmSelectorWidget(IAlgorithmSelectorView, QWidget):
self.search_box = None
self.tree = None
self.algorithm_progress_widget = None
+ self.get_selected_workspace_fn = None
QWidget.__init__(self, parent)
IAlgorithmSelectorView.__init__(self, include_hidden)
self.afo = AlgorithmSelectorFactoryObserver(self)
+ def set_get_selected_workspace_fn(self, get_selected_workspace_fn):
+ self.get_selected_workspace_fn = get_selected_workspace_fn
+
def observeUpdate(self, toggle):
"""
Set whether or not to update AlgorithmSelector if AlgorithmFactory changes
@@ -252,7 +257,19 @@ class AlgorithmSelectorWidget(IAlgorithmSelectorView, QWidget):
Send a signal to a subscriber to execute the selected algorithm
"""
algorithm = self.get_selected_algorithm()
+ presets = {}
+ enabled = []
if algorithm is not None:
+ if self.get_selected_workspace_fn:
+ selected_ws_names = self.get_selected_workspace_fn()
+ if selected_ws_names:
+ property_name = self.presenter.find_input_workspace_property(algorithm)
+ if property_name:
+ presets[property_name] = selected_ws_names[0]
+ # Keep it enabled
+ enabled.append(property_name)
+
manager = InterfaceManager()
- dialog = manager.createDialogFromName(algorithm.name, algorithm.version)
+ dialog = manager.createDialogFromName(algorithm.name, algorithm.version, None,
+ False, presets, "", enabled)
dialog.show()
diff --git a/qt/python/mantidqt/widgets/codeeditor/execution.py b/qt/python/mantidqt/widgets/codeeditor/execution.py
index cfe4eeacd92b5a09d07830d067e17d4aa584b87a..522720757e9b26b5052bc2848ea09a42ab8e105c 100644
--- a/qt/python/mantidqt/widgets/codeeditor/execution.py
+++ b/qt/python/mantidqt/widgets/codeeditor/execution.py
@@ -11,8 +11,15 @@ from __future__ import absolute_import, unicode_literals
import __future__
import ast
+
+try:
+ import builtins
+except ImportError:
+ import __main__
+
+ builtins = __main__.__builtins__
+import copy
import os
-import re
from io import BytesIO
from lib2to3.pgen2.tokenize import detect_encoding
@@ -21,11 +28,13 @@ from qtpy.QtWidgets import QApplication
from mantidqt.utils import AddedToSysPath
from mantidqt.utils.asynchronous import AsyncTask, BlockingAsyncTaskWithCallback
-from mantidqt.widgets.codeeditor.inputsplitter import InputSplitter
+from mantidqt.utils.qt import import_qt
+
+# Core object to execute the code with optinal progress tracking
+CodeExecution = import_qt('..._common', 'mantidqt.widgets.codeeditor.execution', 'CodeExecution')
EMPTY_FILENAME_ID = '<string>'
FILE_ATTR = '__file__'
-COMPILE_MODE = 'exec'
def _get_imported_from_future(code_str):
@@ -44,6 +53,7 @@ def _get_imported_from_future(code_str):
if isinstance(node, ast.ImportFrom):
if node.module == '__future__':
future_imports.extend([import_alias.name for import_alias in node.names])
+ break
return future_imports
@@ -73,21 +83,15 @@ class PythonCodeExecution(QObject):
"""
sig_exec_success = Signal(object)
sig_exec_error = Signal(object)
- sig_exec_progress = Signal(int)
- def __init__(self, startup_code=None):
+ def __init__(self, editor=None):
"""Initialize the object"""
super(PythonCodeExecution, self).__init__()
-
+ self._editor = editor
self._globals_ns = None
-
self._task = None
-
self.reset_context()
- # the code is not executed initially so code completion won't work
- # on variables until part is executed
-
@property
def globals_ns(self):
return self._globals_ns
@@ -129,34 +133,18 @@ class PythonCodeExecution(QObject):
is used
:raises: Any error that the code generates
"""
- if filename:
- self.globals_ns[FILE_ATTR] = filename
- else:
+ if not filename:
filename = EMPTY_FILENAME_ID
- flags = get_future_import_compiler_flags(code_str)
- # This line checks the whole code string for syntax errors, so that no
- # code blocks are executed if the script has invalid syntax.
- try:
- compile(code_str, filename, mode=COMPILE_MODE, dont_inherit=True, flags=flags)
- except SyntaxError as e: # Encoding declarations cause issues in compile calls. If found, remove them.
- if "encoding declaration in Unicode string" in str(e):
- code_str = re.sub("coding[=:]\s*([-\w.]+)", "", code_str, 1)
- compile(code_str, filename, mode=COMPILE_MODE, dont_inherit=True, flags=flags)
- else:
- raise e
+ self.globals_ns[FILE_ATTR] = filename
+ flags = get_future_import_compiler_flags(code_str)
with AddedToSysPath([os.path.dirname(filename)]):
- sig_progress = self.sig_exec_progress
- for block in code_blocks(code_str):
- sig_progress.emit(block.lineno)
- # compile so we can set the filename
- code_obj = compile(block.code_str, filename, mode=COMPILE_MODE,
- dont_inherit=True, flags=flags)
- exec (code_obj, self.globals_ns, self.globals_ns)
+ executor = CodeExecution(self._editor)
+ executor.execute(code_str, filename, flags, self.globals_ns)
def reset_context(self):
# create new context for execution
- self._globals_ns, self._namespace = {}, {}
+ self._globals_ns = copy.copy(builtins.globals())
# --------------------- Callbacks -------------------------------
def _on_success(self, task_result):
@@ -167,51 +155,6 @@ class PythonCodeExecution(QObject):
self._reset_task()
self.sig_exec_error.emit(task_error)
- def _on_progress_updated(self, lineno):
- self.sig_exec_progress(lineno)
-
# --------------------- Private -------------------------------
def _reset_task(self):
self._task = None
-
-
-class CodeBlock(object):
- """Holds an executable code object. It also stores the line number
- of the first line within a larger group of code blocks"""
-
- def __init__(self, code_str, lineno):
- self.code_str = code_str
- self.lineno = lineno
-
-
-def code_blocks(code_str):
- """Generator to produce blocks of executable code
- from the given code string.
- """
- lineno_cur = 0
- lines = code_str.splitlines()
- line_count = len(lines)
- isp = InputSplitter()
- for line in lines:
- lineno_cur += 1
- # IPython InputSplitter assumes that indentation is 4 spaces, not tabs.
- # Accounting for that here, rather than using script-level "tabs to spaces"
- # allows the user to keep tabs in their script if they wish.
- line = line.replace("\t", " "*4)
- isp.push(line)
- # If we need more input to form a complete statement
- # or we are not at the end of the code then keep
- # going
- if isp.push_accepts_more() and lineno_cur != line_count:
- continue
- else:
- # Now we have a complete set of executable statements
- # throw them at the execution engine
- code = isp.source
- isp.reset()
- yield CodeBlock(code, lineno_cur)
- # In order to keep the line numbering in error stack traces
- # consistent each executed block needs to have the statements
- # on the same line as they are in the real code so we prepend
- # blank lines to make this so
- isp.push('\n' * lineno_cur)
diff --git a/qt/python/mantidqt/widgets/codeeditor/inputsplitter.py b/qt/python/mantidqt/widgets/codeeditor/inputsplitter.py
deleted file mode 100644
index e772b25499b9b3195d024dcf740f2bf58d1cbbd8..0000000000000000000000000000000000000000
--- a/qt/python/mantidqt/widgets/codeeditor/inputsplitter.py
+++ /dev/null
@@ -1,115 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2017 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-# This file is part of the mantidqt package
-#
-#
-from __future__ import (absolute_import, unicode_literals)
-
-# std imports
-
-# 3rd party imports
-from IPython.core.inputsplitter import InputSplitter as IPyInputSplitter
-
-# local imports
-
-
-class InputSplitter(IPyInputSplitter):
- r"""A specialized version of IPython's input splitter.
-
- The major differences between this and the base version are:
-
- - push considers a SyntaxError as incomplete code
- - push_accepts_more returns False when the indentation has return flush
- regardless of whether the statement is a single line
- """
-
- def push(self, lines):
- """Push one or more lines of input.
-
- This stores the given lines and returns a status code indicating
- whether the code forms a complete Python block or not.
-
- Any exceptions generated in compilation are swallowed, but if an
- exception was produced, the method returns True.
-
- Parameters
- ----------
- lines : string
- One or more lines of Python input.
-
- Returns
- -------
- is_complete : boolean
- True if the current input source (the result of the current input
- plus prior inputs) forms a complete Python execution block. Note that
- this value is also stored as a private attribute (``_is_complete``), so it
- can be queried at any time.
- """
- self._store(lines)
- source = self.source
-
- # Before calling _compile(), reset the code object to None so that if an
- # exception is raised in compilation, we don't mislead by having
- # inconsistent code/source attributes.
- self.code, self._is_complete = None, None
-
- # Honor termination lines properly
- if source.endswith('\\\n'):
- return False
-
- try:
- self._update_indent(lines)
- except TypeError: # _update_indent was changed in IPython 6.0
- self._update_indent()
- except AttributeError: # changed definition in IPython 6.3
- self.get_indent_spaces()
- try:
- self.code = self._compile(source, symbol="exec")
- # Invalid syntax can produce any of a number of different errors from
- # inside the compiler, so we have to catch them all. Syntax errors
- # immediately produce a 'ready' block, so the invalid Python can be
- # sent to the kernel for evaluation with possible ipython
- # special-syntax conversion.
- except (SyntaxError, OverflowError, ValueError, TypeError,
- MemoryError):
- self._is_complete = False
- else:
- # Compilation didn't produce any exceptions (though it may not have
- # given a complete code object)
- self._is_complete = self.code is not None
-
- return self._is_complete
-
- def push_accepts_more(self):
- """Return whether a block of input can accept more input.
-
- This method is meant to be used by line-oriented frontends, who need to
- guess whether a block is complete or not based solely on prior and
- current input lines. The InputSplitter considers it has a complete
- block and will not accept more input when either:
-
- * A SyntaxError is raised
-
- * The code is complete and consists of a single line or a single
- non-compound statement
-
- * The code is complete and has a blank line at the end
- """
-
- # With incomplete input, unconditionally accept more
- # A syntax error also sets _is_complete to True - see push()
- if not self._is_complete:
- return True
-
- # If there's just a single line or AST node, and we're flush left, as is
- # the case after a simple statement such as 'a=1', we want to execute it
- # straight away.
- if self.indent_spaces == 0:
- return False
-
- # General fallback - accept more code
- return True
diff --git a/qt/python/mantidqt/widgets/codeeditor/interpreter.py b/qt/python/mantidqt/widgets/codeeditor/interpreter.py
index c305060fe7e6fbd62ed056c7d7be9b4c4a6456cf..1394f0699401b92e4828f6842eabe549d961d2a1 100644
--- a/qt/python/mantidqt/widgets/codeeditor/interpreter.py
+++ b/qt/python/mantidqt/widgets/codeeditor/interpreter.py
@@ -95,7 +95,7 @@ class EditorIO(object):
self.editor.setFileName(filename)
try:
- with io.open(filename, 'w', encoding='utf8') as f:
+ with io.open(filename, 'w', encoding='utf8', newline='') as f:
f.write(self.editor.text())
self.editor.setModified(False)
except IOError as exc:
@@ -136,7 +136,7 @@ class PythonFileInterpreter(QWidget):
self.setLayout(self.layout)
self._setup_editor(content, filename)
- self._presenter = PythonFileInterpreterPresenter(self, PythonCodeExecution(content))
+ self._presenter = PythonFileInterpreterPresenter(self, PythonCodeExecution(self.editor))
self.code_commenter = CodeCommenter(self.editor)
self.code_completer = CodeCompleter(self.editor, self._presenter.model.globals_ns)
@@ -146,7 +146,6 @@ class PythonFileInterpreter(QWidget):
self.setAttribute(Qt.WA_DeleteOnClose, True)
# Connect the model signals to the view's signals so they can be accessed from outside the MVP
- self._presenter.model.sig_exec_progress.connect(self.sig_progress)
self._presenter.model.sig_exec_error.connect(self.sig_exec_error)
self._presenter.model.sig_exec_success.connect(self.sig_exec_success)
@@ -225,9 +224,11 @@ class PythonFileInterpreter(QWidget):
self.replace_text(SPACE_CHAR * TAB_WIDTH, TAB_CHAR)
def set_whitespace_visible(self):
+ self.editor.setEolVisibility(True)
self.editor.setWhitespaceVisibility(CodeEditor.WsVisible)
def set_whitespace_invisible(self):
+ self.editor.setEolVisibility(False)
self.editor.setWhitespaceVisibility(CodeEditor.WsInvisible)
def toggle_comment(self):
@@ -283,7 +284,6 @@ class PythonFileInterpreterPresenter(QObject):
# connect signals
self.model.sig_exec_success.connect(self._on_exec_success)
self.model.sig_exec_error.connect(self._on_exec_error)
- self.model.sig_exec_progress.connect(self._on_progress_update)
# starts idle
self.view.set_status_message(IDLE_STATUS_MSG)
@@ -338,7 +338,14 @@ class PythonFileInterpreterPresenter(QObject):
if hasattr(exc_value, 'lineno'):
lineno = exc_value.lineno + self._code_start_offset
elif exc_stack is not None:
- lineno = exc_stack[-1][1] + self._code_start_offset
+ try:
+ lineno = exc_stack[0].lineno + self._code_start_offset
+ except (AttributeError, IndexError):
+ # Python 2 fallback
+ try:
+ lineno = exc_stack[-1][1] + self._code_start_offset
+ except IndexError:
+ lineno = -1
else:
lineno = -1
sys.stderr.write(self._error_formatter.format(exc_type, exc_value, exc_stack) + os.linesep)
diff --git a/qt/python/mantidqt/widgets/codeeditor/test/test_execution.py b/qt/python/mantidqt/widgets/codeeditor/test/test_execution.py
index c6ae55a3298ac853f12c1dd7c87ccfc421e52801..16b148b288c9e6535f90d9fca6dd7a68e471fc3f 100644
--- a/qt/python/mantidqt/widgets/codeeditor/test/test_execution.py
+++ b/qt/python/mantidqt/widgets/codeeditor/test/test_execution.py
@@ -21,6 +21,7 @@ from qtpy.QtCore import QCoreApplication, QObject
# local imports
from mantid.py3compat import StringIO
from mantid.py3compat.mock import patch
+
from mantidqt.utils.qt.testing import start_qapplication
from mantidqt.widgets.codeeditor.execution import PythonCodeExecution, _get_imported_from_future
@@ -38,34 +39,21 @@ class Receiver(QObject):
self.error_stack = traceback.extract_tb(task_result.stack)
-class ReceiverWithProgress(Receiver):
-
- def __init__(self):
- super(ReceiverWithProgress, self).__init__()
- self.lines_received = []
-
- def on_progess_update(self, lineno):
- self.lines_received.append(lineno)
-
-
@start_qapplication
class PythonCodeExecutionTest(unittest.TestCase):
- def test_default_construction_yields_empty_context(self):
+ def test_default_construction_context_contains_builtins(self):
executor = PythonCodeExecution()
- self.assertEqual(0, len(executor.globals_ns))
+ self.assertTrue('__builtins__' in executor.globals_ns)
- def test_reset_context_clears_context(self):
+ def test_reset_context_remove_user_content(self):
executor = PythonCodeExecution()
- globals_len = len(executor.globals_ns)
executor.execute("x = 1")
- self.assertTrue(globals_len + 1, len(executor.globals_ns))
+ self.assertTrue('x' in executor.globals_ns)
executor.reset_context()
- self.assertEqual(0, len(executor.globals_ns))
- def test_startup_code_not_executed_by_default(self):
- executor = PythonCodeExecution(startup_code="x=100")
self.assertFalse('x' in executor.globals_ns)
+ self.assertTrue('__builtins__' in executor.globals_ns)
# ---------------------------------------------------------------------------
# Successful execution tests
@@ -84,10 +72,10 @@ class PythonCodeExecutionTest(unittest.TestCase):
self.assertTrue('__file__' in executor.globals_ns)
self.assertEqual(test_filename, executor.globals_ns['__file__'])
- def test_empty_filename_does_not_set__file__attr(self):
+ def test_empty_filename_sets_identifier(self):
executor = PythonCodeExecution()
executor.execute('x=1')
- self.assertTrue('__file__' not in executor.globals_ns)
+ self.assertTrue('__file__' in executor.globals_ns)
def test_execute_async_calls_success_signal_on_completion(self):
code = "x=1+2"
@@ -131,6 +119,8 @@ class PythonCodeExecutionTest(unittest.TestCase):
executor.execute(code)
self.assertEqual("This should have no brackets\n", mock_stdout.getvalue())
+ @unittest.skipIf(sys.version_info < (3,),
+ "Unable to get this working on Python 2 and we are closing to dropping it")
@patch('sys.stdout', new_callable=StringIO)
def test_scripts_can_print_unicode_if_unicode_literals_imported(self, mock_stdout):
code = ("from __future__ import unicode_literals\n"
@@ -171,7 +161,7 @@ def foo():
bar()
foo()
"""
- executor, recv = self._run_async_code(code, with_progress=True)
+ executor, recv = self._run_async_code(code)
self.assertFalse(recv.success_cb_called)
self.assertTrue(recv.error_cb_called)
self.assertTrue(isinstance(recv.task_exc, NameError),
@@ -184,68 +174,6 @@ foo()
self.assertEqual(7, recv.error_stack[3][1])
self.assertEqual(5, recv.error_stack[4][1])
- # ---------------------------------------------------------------------------
- # Progress tests
- # ---------------------------------------------------------------------------
- def test_progress_cb_is_not_called_for_empty_string(self):
- code = ""
- executor, recv = self._run_async_code(code, with_progress=True)
- self.assertEqual(0, len(recv.lines_received))
-
- def test_progress_cb_is_not_called_for_code_with_syntax_errors(self):
- code = """x = 1
-y =
-"""
- executor, recv = self._run_async_code(code, with_progress=True)
- self.assertEqual(0, len(recv.lines_received))
- self.assertFalse(recv.success_cb_called)
- self.assertTrue(recv.error_cb_called)
- self.assertEqual(0, len(recv.lines_received))
-
- def test_progress_cb_is_called_for_single_line(self):
- code = "x = 1"
- executor, recv = self._run_async_code(code, with_progress=True)
- if not recv.success_cb_called:
- self.assertTrue(recv.error_cb_called)
- self.fail("Execution failed with error:\n" + str(recv.task_exc))
-
- self.assertEqual([1], recv.lines_received)
-
- def test_progress_cb_is_called_for_multiple_single_lines(self):
- code = """x = 1
-y = 2
-"""
- executor, recv = self._run_async_code(code, with_progress=True)
- if not recv.success_cb_called:
- self.assertTrue(recv.error_cb_called)
- self.fail("Execution failed with error:\n" + str(recv.task_exc))
-
- self.assertEqual([1, 2], recv.lines_received)
-
- def test_progress_cb_is_called_for_mix_single_lines_and_blocks(self):
- code = """x = 1
-# comment line
-
-sum = 0
-for i in range(10):
- if i %2 == 0:
- sum += i
-
-squared = sum*sum
-"""
- executor, recv = self._run_async_code(code, with_progress=True)
- if not recv.success_cb_called:
- if recv.error_cb_called:
- self.fail("Unexpected error found: " + str(recv.task_exc))
- else:
- self.fail("No callback was called!")
-
- context = executor.globals_ns
- self.assertEqual(20, context['sum'])
- self.assertEqual(20*20, context['squared'])
- self.assertEqual(1, context['x'])
- self.assertEqual([1, 2, 3, 4, 9], recv.lines_received)
-
# -------------------------------------------------------------------------
# Filename checks
# -------------------------------------------------------------------------
@@ -274,13 +202,9 @@ squared = sum*sum
executor = PythonCodeExecution()
self.assertRaises(expected_exc_type, executor.execute, code)
- def _run_async_code(self, code, with_progress=False, filename=None):
+ def _run_async_code(self, code, filename=None):
executor = PythonCodeExecution()
- if with_progress:
- recv = ReceiverWithProgress()
- executor.sig_exec_progress.connect(recv.on_progess_update)
- else:
- recv = Receiver()
+ recv = Receiver()
executor.sig_exec_success.connect(recv.on_success)
executor.sig_exec_error.connect(recv.on_error)
task = executor.execute_async(code, filename)
diff --git a/qt/python/mantidqt/widgets/colorbar/colorbar.py b/qt/python/mantidqt/widgets/colorbar/colorbar.py
index 41eea96614c968d8f2c936ab0cfbd3feeaab84bb..3628dd7d34bc1a6b9032f77e118e11a9373f55b7 100644
--- a/qt/python/mantidqt/widgets/colorbar/colorbar.py
+++ b/qt/python/mantidqt/widgets/colorbar/colorbar.py
@@ -9,7 +9,7 @@
#
from __future__ import (absolute_import, division, print_function)
-from mantid.plots.utility import mpl_version_info
+from mantid.plots.utility import mpl_version_info, get_current_cmap
from mantidqt.MPLwidgets import FigureCanvas
from matplotlib.colorbar import Colorbar
from matplotlib.figure import Figure
@@ -103,7 +103,7 @@ class ColorbarWidget(QWidget):
"""
self.ax.clear()
try: # Use current cmap
- cmap = self.colorbar.get_cmap()
+ cmap = get_current_cmap(self.colorbar)
except AttributeError:
try: # else use viridis
cmap = cm.viridis
@@ -113,7 +113,9 @@ class ColorbarWidget(QWidget):
self.cmin_value, self.cmax_value = mappable.get_clim()
self.update_clim_text()
self.cmap_changed(cmap)
- self.cmap.setCurrentIndex(sorted(cm.cmap_d.keys()).index(mappable.get_cmap().name))
+
+ mappable_cmap = get_current_cmap(mappable)
+ self.cmap.setCurrentIndex(sorted(cm.cmap_d.keys()).index(mappable_cmap.name))
self.redraw()
def cmap_index_changed(self):
@@ -132,7 +134,7 @@ class ColorbarWidget(QWidget):
Updates the colormap and min/max values of the colorbar
when the plot changes via settings.
"""
- mappable_cmap = self.colorbar.mappable.get_cmap()
+ mappable_cmap = get_current_cmap(self.colorbar.mappable)
low, high = self.colorbar.mappable.get_clim()
self.cmin_value = low
self.cmax_value = high
diff --git a/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/add_function_dialog.ui b/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/add_function_dialog.ui
index 56f0cf8009ecbc7745d3ee1f394c01f973cd884d..555487489826d31b5b6113875da79b093ccc6559 100644
--- a/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/add_function_dialog.ui
+++ b/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/add_function_dialog.ui
@@ -10,7 +10,7 @@
<x>0</x>
<y>0</y>
<width>254</width>
- <height>89</height>
+ <height>90</height>
</rect>
</property>
<property name="windowTitle">
@@ -46,14 +46,31 @@
</layout>
</item>
<item>
- <widget class="QDialogButtonBox" name="buttonBox">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="standardButtons">
- <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
- </property>
- </widget>
+ <layout class="QHBoxLayout" name="horizontalLayout">
+ <item>
+ <widget class="QPushButton" name="helpButton">
+ <property name="maximumSize">
+ <size>
+ <width>25</width>
+ <height>16777215</height>
+ </size>
+ </property>
+ <property name="text">
+ <string>?</string>
+ </property>
+ </widget>
+ </item>
+ <item>
+ <widget class="QDialogButtonBox" name="buttonBox">
+ <property name="orientation">
+ <enum>Qt::Horizontal</enum>
+ </property>
+ <property name="standardButtons">
+ <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+ </property>
+ </widget>
+ </item>
+ </layout>
</item>
</layout>
</widget>
diff --git a/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/presenter.py b/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/presenter.py
index 73b6b8d98d23550afd42ee641af2999680d720a5..2feadcfd7d84e3722d7525492a18954d61d3b65f 100644
--- a/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/presenter.py
+++ b/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/presenter.py
@@ -7,6 +7,7 @@
from __future__ import (absolute_import, unicode_literals)
from .view import AddFunctionDialogView
+from mantidqt.interfacemanager import InterfaceManager
class AddFunctionDialog(object):
@@ -17,6 +18,7 @@ class AddFunctionDialog(object):
def __init__(self, parent = None, function_names = None, view=None):
self.view = view if view else AddFunctionDialogView(parent, function_names)
self.view.ui.buttonBox.accepted.connect(lambda: self.action_add_function())
+ self.view.ui.helpButton.clicked.connect(self.function_help_dialog)
def action_add_function(self):
current_function = self.view.ui.functionBox.currentText()
@@ -25,3 +27,6 @@ class AddFunctionDialog(object):
self.view.accept()
else:
self.view.set_error_message("Function %s not found " % current_function)
+
+ def function_help_dialog(self):
+ InterfaceManager().showFitFunctionHelp(self.view.ui.functionBox.currentText())
diff --git a/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/view.py b/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/view.py
index a01676c6f8f125c58503a3ff1e18767e625f5bd6..c9b3f8fcd6186be27e245ae070b8a9f06ad1a4c9 100644
--- a/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/view.py
+++ b/qt/python/mantidqt/widgets/fitpropertybrowser/addfunctiondialog/view.py
@@ -24,11 +24,10 @@ class AddFunctionDialogView(QDialog):
def _setup_ui(self, function_names):
self.ui = load_ui(__file__, 'add_function_dialog.ui', self)
- function_box = self.ui.functionBox
if function_names:
self.ui.functionBox.addItems(function_names)
- function_box.completer().setCompletionMode(QCompleter.PopupCompletion)
- function_box.completer().setFilterMode(Qt.MatchContains)
+ self.ui.functionBox.completer().setCompletionMode(QCompleter.PopupCompletion)
+ self.ui.functionBox.completer().setFilterMode(Qt.MatchContains)
self.ui.errorMessage.hide()
def is_text_in_function_list(self, function):
diff --git a/qt/python/mantidqt/widgets/fitpropertybrowser/fitpropertybrowser.py b/qt/python/mantidqt/widgets/fitpropertybrowser/fitpropertybrowser.py
index 26562feeafa3e0a333a3d74495a2ff9b709578c1..3c7c8534ad366f8fd7acd8e7bf25bbbaf164003d 100644
--- a/qt/python/mantidqt/widgets/fitpropertybrowser/fitpropertybrowser.py
+++ b/qt/python/mantidqt/widgets/fitpropertybrowser/fitpropertybrowser.py
@@ -64,7 +64,7 @@ class FitPropertyBrowser(FitPropertyBrowserBase):
self.plotGuess.connect(self.plot_guess_slot, Qt.QueuedConnection)
self.functionChanged.connect(self.function_changed_slot, Qt.QueuedConnection)
# Update whether data needs to be normalised when a button on the Fit menu is clicked
- self.getFitMenu().aboutToShow.connect(self._set_normalise_data_from_workspace_artist)
+ self.getFitMenu().aboutToShow.connect(self._set_normalise_data)
self.sequentialFitDone.connect(self._sequential_fit_done_slot)
self.workspaceClicked.connect(self.display_workspace)
@@ -109,16 +109,22 @@ class FitPropertyBrowser(FitPropertyBrowserBase):
if ws_artists.workspace_index == self.workspaceIndex():
return ws_artists
- def _set_normalise_data_from_workspace_artist(self):
+ def _set_normalise_data(self):
"""
Set if the data should be normalised before fitting using the
normalisation state of the active workspace artist.
- """
- if AnalysisDataService.doesExist(self.workspaceName()) \
- and isinstance(AnalysisDataService.retrieve(self.workspaceName()), ITableWorkspace):
- return
+ If the workspace is a distribution normalisation is set to False so it is not normalised twice.
+ """
+ ws_is_distribution = False
+ if AnalysisDataService.doesExist(self.workspaceName()):
+ workspace = AnalysisDataService.retrieve(self.workspaceName())
+ if isinstance(workspace, ITableWorkspace):
+ return
+ if hasattr(workspace, 'isDistribution') and workspace.isDistribution():
+ ws_is_distribution = True
ws_artist = self._get_selected_workspace_artist()
- self.normaliseData(ws_artist.is_normalized)
+ should_normalise_before_fit = ws_artist.is_normalized and not ws_is_distribution
+ self.normaliseData(should_normalise_before_fit)
def closeEvent(self, event):
"""
diff --git a/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/__init__.py b/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/__init__.py
index 0affc457bedbdbcc749a256f9df4ee1f2e37e052..1178d8ce472bf17e87c4dd2b88c83b7d3e389dce 100644
--- a/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/__init__.py
+++ b/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/__init__.py
@@ -14,8 +14,8 @@ from matplotlib.lines import Line2D
from numpy import isclose
from qtpy.QtCore import Qt
-from mantid.plots import MantidAxes
-from mantid.plots.helperfunctions import errorbars_hidden
+from mantid.plots.mantidaxes import MantidAxes
+from mantid.plots.datafunctions import errorbars_hidden
from mantidqt.widgets.plotconfigdialog.colorselector import convert_color_to_hex
LINESTYLE_MAP = {'-': 'solid', '--': 'dashed', '-.': 'dashdot', ':': 'dotted',
diff --git a/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/presenter.py b/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/presenter.py
index bf007b160ce1162ecf4db2a7a51d044a83b8b919..9aa448419547de90e310446c2e32f895bdb78da7 100644
--- a/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/presenter.py
+++ b/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/presenter.py
@@ -9,9 +9,10 @@
from __future__ import (absolute_import, unicode_literals)
from matplotlib.collections import PolyCollection
+from matplotlib.lines import Line2D
from mantid.plots.legend import LegendProperties
-from mantid.plots import helperfunctions, Line2D, MantidAxes
+from mantid.plots import datafunctions, MantidAxes
from mantidqt.utils.qt import block_signals
from mantidqt.widgets.plotconfigdialog import get_axes_names_dict, curve_in_ax
from mantidqt.widgets.plotconfigdialog.curvestabwidget import (
@@ -117,7 +118,7 @@ class CurvesTabWidgetPresenter:
# If the plot is a waterfall plot and the user has set it so the area under each line is filled, and the fill
# colour for each line is set as the line colour, after the curve is updated we need to check if its colour has
# changed so the fill can be updated accordingly.
- if waterfall and ax.waterfall_has_fill() and helperfunctions.waterfall_fill_is_line_colour(ax):
+ if waterfall and ax.waterfall_has_fill() and datafunctions.waterfall_fill_is_line_colour(ax):
check_line_colour = True
if isinstance(curve, Line2D):
@@ -131,7 +132,7 @@ class CurvesTabWidgetPresenter:
self.curve_names_dict[self.view.get_selected_curve_name()] = new_curve
if isinstance(ax, MantidAxes):
- errorbar_cap_lines = helperfunctions.remove_and_return_errorbar_cap_lines(ax)
+ errorbar_cap_lines = datafunctions.remove_and_return_errorbar_cap_lines(ax)
else:
errorbar_cap_lines = []
@@ -148,12 +149,12 @@ class CurvesTabWidgetPresenter:
update_fill = curve.get_color() != new_curve[0].get_color()
else:
update_fill = curve[0].get_color() != new_curve[0].get_color()
- helperfunctions.convert_single_line_to_waterfall(ax, curve_index, need_to_update_fill=update_fill)
+ datafunctions.convert_single_line_to_waterfall(ax, curve_index, need_to_update_fill=update_fill)
else:
# the curve has been reset to its original position so for a waterfall plot it needs to be re-offset.
- helperfunctions.convert_single_line_to_waterfall(ax, curve_index)
+ datafunctions.convert_single_line_to_waterfall(ax, curve_index)
- helperfunctions.set_waterfall_fill_visible(ax, curve_index)
+ datafunctions.set_waterfall_fill_visible(ax, curve_index)
ax.lines += errorbar_cap_lines
diff --git a/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/test/test_curvestabwidgetpresenter.py b/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/test/test_curvestabwidgetpresenter.py
index f68d7da7f6a681769b07bec27373f2a5ed26d1d7..98301983437b672c42320441db355ae91d42180b 100644
--- a/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/test/test_curvestabwidgetpresenter.py
+++ b/qt/python/mantidqt/widgets/plotconfigdialog/curvestabwidget/test/test_curvestabwidgetpresenter.py
@@ -17,7 +17,7 @@ from matplotlib.pyplot import figure
from numpy import array_equal
from mantid.simpleapi import CreateWorkspace
-from mantid.plots import helperfunctions
+from mantid.plots import datafunctions
from mantid.plots.utility import MantidAxType
from mantid.py3compat.mock import Mock, patch
from mantidqt.widgets.plotconfigdialog.colorselector import convert_color_to_hex
@@ -316,7 +316,7 @@ class CurvesTabWidgetPresenterTest(unittest.TestCase):
new_plot_kwargs = {'visible': False}
presenter._replot_selected_curve(new_plot_kwargs)
- self.assertEqual(helperfunctions.get_waterfall_fill_for_curve(ax, 0).get_visible(), False)
+ self.assertEqual(datafunctions.get_waterfall_fill_for_curve(ax, 0).get_visible(), False)
def test_changing_line_colour_on_a_waterfall_plot_with_filled_areas_changes_fill_colour_to_match(self):
fig = self.make_figure_with_multiple_curves()
diff --git a/qt/python/mantidqt/widgets/plotconfigdialog/imagestabwidget/__init__.py b/qt/python/mantidqt/widgets/plotconfigdialog/imagestabwidget/__init__.py
index 6e458d5e7dcc097e1df30a9e48d87cfafe678618..08cdcedc4722dd7526475e02f1f7392c7ef43e6c 100644
--- a/qt/python/mantidqt/widgets/plotconfigdialog/imagestabwidget/__init__.py
+++ b/qt/python/mantidqt/widgets/plotconfigdialog/imagestabwidget/__init__.py
@@ -24,7 +24,8 @@ class ImageProperties(dict):
def from_image(cls, image):
props = dict()
props['label'] = image.get_label()
- props['colormap'] = image.get_cmap().name
+ cmap_name = image.cmap.name if hasattr(image,"cmap") else image.get_cmap().name
+ props['colormap'] = cmap_name
props['reverse_colormap'] = False
if props['colormap'].endswith('_r'):
props['colormap'] = props['colormap'][:-2]
diff --git a/qt/python/mantidqt/widgets/plotconfigdialog/imagestabwidget/presenter.py b/qt/python/mantidqt/widgets/plotconfigdialog/imagestabwidget/presenter.py
index 1743ed6de8d96d39a7f7258839728873100d84e5..1ed80b8cd2e1ed75081493f2181b118e7fc0b12d 100644
--- a/qt/python/mantidqt/widgets/plotconfigdialog/imagestabwidget/presenter.py
+++ b/qt/python/mantidqt/widgets/plotconfigdialog/imagestabwidget/presenter.py
@@ -8,7 +8,7 @@
from __future__ import (absolute_import, unicode_literals)
-from mantid.plots.helperfunctions import update_colorbar_scale
+from mantid.plots.datafunctions import update_colorbar_scale
from mantidqt.utils.qt import block_signals
from mantidqt.widgets.plotconfigdialog import generate_ax_name, get_images_from_fig
from mantidqt.widgets.plotconfigdialog.imagestabwidget import ImageProperties
diff --git a/qt/python/mantidqt/widgets/sliceviewer/model.py b/qt/python/mantidqt/widgets/sliceviewer/model.py
index effc709f9aa629d9a2bd4309dfee1285bc879677..736fb459fd93aefc38226fb78a8966a0bc9edca2 100644
--- a/qt/python/mantidqt/widgets/sliceviewer/model.py
+++ b/qt/python/mantidqt/widgets/sliceviewer/model.py
@@ -8,7 +8,7 @@
#
#
from __future__ import (absolute_import, division, print_function)
-from mantid.plots.helperfunctions import get_indices
+from mantid.plots.datafunctions import get_indices
from mantid.api import MatrixWorkspace, MultipleExperimentInfos
from mantid.simpleapi import BinMD
from mantid.py3compat.enum import Enum
diff --git a/qt/python/mantidqt/widgets/sliceviewer/samplingimage.py b/qt/python/mantidqt/widgets/sliceviewer/samplingimage.py
index 64ef0658a422e31a4dec3cdf4357998da49aa8ee..f95e6c299d874b86877ebedcbb228e68bc9400fc 100644
--- a/qt/python/mantidqt/widgets/sliceviewer/samplingimage.py
+++ b/qt/python/mantidqt/widgets/sliceviewer/samplingimage.py
@@ -1,6 +1,6 @@
import matplotlib.image as mimage
import matplotlib.colors
-from mantid.plots.plotfunctions import _setLabels2D
+from mantid.plots.axesfunctions import _setLabels2D
import mantid.api
import numpy as np
diff --git a/qt/python/mantidqt/widgets/sliceviewer/view.py b/qt/python/mantidqt/widgets/sliceviewer/view.py
index c1f4865daca0dfed58a40e003213c72cdc91a87e..e5fd1eb8b526abe8fd71858ba3b197ca86fabbb3 100644
--- a/qt/python/mantidqt/widgets/sliceviewer/view.py
+++ b/qt/python/mantidqt/widgets/sliceviewer/view.py
@@ -14,7 +14,7 @@ from matplotlib.figure import Figure
from matplotlib.transforms import Bbox, BboxTransform
import mantid.api
-from mantid.plots.helperfunctions import get_normalize_by_bin_width
+from mantid.plots.datafunctions import get_normalize_by_bin_width
from mantidqt.MPLwidgets import FigureCanvas
from mantidqt.widgets.colorbar.colorbar import ColorbarWidget
from .dimensionwidget import DimensionWidget
diff --git a/qt/python/mantidqt/widgets/test/test_fitpropertybrowser.py b/qt/python/mantidqt/widgets/test/test_fitpropertybrowser.py
index 8186474d1133036d768884c23bef833b21b6fd27..8631edc418240ccbeddeb12ec08569a5a5bec4a8 100644
--- a/qt/python/mantidqt/widgets/test/test_fitpropertybrowser.py
+++ b/qt/python/mantidqt/widgets/test/test_fitpropertybrowser.py
@@ -10,10 +10,11 @@ import unittest
import matplotlib
matplotlib.use('AGG') # noqa
+from numpy import zeros
from mantid.api import AnalysisDataService, WorkspaceFactory
from mantid.py3compat.mock import MagicMock, Mock, patch
-from mantid.simpleapi import CreateSampleWorkspace
+from mantid.simpleapi import CreateSampleWorkspace, CreateWorkspace
from mantidqt.plotting.functions import plot
from mantidqt.utils.qt.testing import start_qapplication
from mantidqt.widgets.fitpropertybrowser.fitpropertybrowser import FitPropertyBrowser
@@ -32,8 +33,7 @@ class FitPropertyBrowserTest(unittest.TestCase):
def test_initialization_does_not_raise(self):
assertRaisesNothing(self, self._create_widget)
- @patch('mantidqt.widgets.fitpropertybrowser.fitpropertybrowser.FitPropertyBrowser.normaliseData'
- )
+ @patch('mantidqt.widgets.fitpropertybrowser.fitpropertybrowser.FitPropertyBrowser.normaliseData')
def test_normalise_data_set_on_fit_menu_shown(self, normaliseData_mock):
for normalised in [True, False]:
ws_artist_mock = Mock(is_normalized=normalised, workspace_index=0)
@@ -45,6 +45,14 @@ class FitPropertyBrowserTest(unittest.TestCase):
property_browser.normaliseData.assert_called_once_with(normalised)
normaliseData_mock.reset_mock()
+ @patch('mantidqt.widgets.fitpropertybrowser.fitpropertybrowser.FitPropertyBrowser.normaliseData')
+ def test_normalise_data_set_to_false_for_distribution_workspace(self, normaliseData_mock):
+ fig, canvas = self._create_and_plot_matrix_workspace('ws_name', distribution=True)
+ property_browser = self._create_widget(canvas=canvas)
+ with patch.object(property_browser, 'workspaceName', lambda: 'ws_name'):
+ property_browser.getFitMenu().aboutToShow.emit()
+ property_browser.normaliseData.assert_called_once_with(False)
+
def test_plot_guess_plots_for_table_workspaces(self):
table = WorkspaceFactory.createTable()
table.addColumn('double', 'X', 1)
@@ -226,9 +234,9 @@ class FitPropertyBrowserTest(unittest.TestCase):
def _create_widget(self, canvas=MagicMock(), toolbar_manager=Mock()):
return FitPropertyBrowser(canvas, toolbar_manager)
- def _create_and_plot_matrix_workspace(self, name = "workspace"):
- ws = WorkspaceFactory.Instance().create("Workspace2D", NVectors=2, YLength=5, XLength=5)
- AnalysisDataService.Instance().addOrReplace(name, ws)
+ def _create_and_plot_matrix_workspace(self, name = "workspace", distribution = False):
+ ws = CreateWorkspace(OutputWorkspace = name, DataX=zeros(10), DataY=zeros(10),
+ NSpec=2, Distribution=distribution)
fig = plot([ws], spectrum_nums=[1])
canvas = fig.canvas
return fig, canvas
diff --git a/qt/python/mantidqt/widgets/waterfallplotfillareadialog/presenter.py b/qt/python/mantidqt/widgets/waterfallplotfillareadialog/presenter.py
index cc3d52a0bcf0f7a8f4af41183c023a9bb6f13bff..cac8bf3e8d22a6e691128e972f3a27935dfb1935 100644
--- a/qt/python/mantidqt/widgets/waterfallplotfillareadialog/presenter.py
+++ b/qt/python/mantidqt/widgets/waterfallplotfillareadialog/presenter.py
@@ -10,7 +10,7 @@ from __future__ import (absolute_import, unicode_literals)
from matplotlib.collections import PolyCollection
-from mantid.plots import helperfunctions
+from mantid.plots import datafunctions
from mantidqt.widgets.plotconfigdialog.colorselector import convert_color_to_hex
from mantidqt.widgets.waterfallplotfillareadialog.view import WaterfallPlotFillAreaDialogView
@@ -41,7 +41,7 @@ class WaterfallPlotFillAreaDialogPresenter:
if self.ax.waterfall_has_fill():
self.view.enable_fill_group_box.setChecked(True)
- if helperfunctions.waterfall_fill_is_line_colour(self.ax):
+ if datafunctions.waterfall_fill_is_line_colour(self.ax):
self.view.use_line_colour_radio_button.setChecked(True)
else:
self.view.use_solid_colour_radio_button.setChecked(True)
@@ -59,7 +59,7 @@ class WaterfallPlotFillAreaDialogPresenter:
self.remove_fill()
def line_colour_fill(self):
- helperfunctions.line_colour_fill(self.ax)
+ datafunctions.line_colour_fill(self.ax)
def solid_colour_fill(self):
# If the colour selector has been changed then presumably the user wants to set a custom fill colour
@@ -69,7 +69,7 @@ class WaterfallPlotFillAreaDialogPresenter:
colour = self.view.colour_selector_widget.get_color()
- helperfunctions.solid_colour_fill(self.ax, colour)
+ datafunctions.solid_colour_fill(self.ax, colour)
def create_fill(self):
self.ax.set_waterfall_fill(True)
diff --git a/qt/python/mantidqt/widgets/waterfallplotfillareadialog/test/test_waterfallplotfillareadialogpresenter.py b/qt/python/mantidqt/widgets/waterfallplotfillareadialog/test/test_waterfallplotfillareadialogpresenter.py
index 4d16c751482d5a5d58d6d1b784aec26f4ac5fa63..2c1c25b7bf07a86271d4eee6c55738d11dd2ec20 100644
--- a/qt/python/mantidqt/widgets/waterfallplotfillareadialog/test/test_waterfallplotfillareadialogpresenter.py
+++ b/qt/python/mantidqt/widgets/waterfallplotfillareadialog/test/test_waterfallplotfillareadialogpresenter.py
@@ -13,7 +13,7 @@ import unittest
from matplotlib.collections import PolyCollection
from matplotlib.pyplot import figure
-from mantid.plots import helperfunctions
+from mantid.plots import datafunctions
from mantid.py3compat.mock import Mock
from mantidqt.widgets.waterfallplotfillareadialog.presenter import WaterfallPlotFillAreaDialogPresenter
@@ -40,7 +40,7 @@ class WaterfallPlotFillAreaDialogPresenterTest(unittest.TestCase):
self.presenter.view.use_line_colour_radio_button.isChecked.return_value = True
self.presenter.set_fill_enabled()
- self.assertTrue(helperfunctions.waterfall_fill_is_line_colour(self.ax))
+ self.assertTrue(datafunctions.waterfall_fill_is_line_colour(self.ax))
def test_enabling_fill_with_solid_colour_creates_fills_with_one_colour(self):
self.presenter.view.enable_fill_group_box.isChecked.return_value = True
diff --git a/qt/scientific_interfaces/CMakeLists.txt b/qt/scientific_interfaces/CMakeLists.txt
index b9387054c8987cd47b2804d8bfbd9644de355a0b..fa92d021eea814aec282d030c324cf92184ac18b 100644
--- a/qt/scientific_interfaces/CMakeLists.txt
+++ b/qt/scientific_interfaces/CMakeLists.txt
@@ -76,6 +76,11 @@ set(TEST_FILES
test/ISISReflectometry/Common/EncoderTest.h
)
+set(CXXTEST_EXTRA_HEADER_INCLUDE
+ ${CMAKE_CURRENT_LIST_DIR}/test/ScientificInterfacesTestInitialization.h)
+
+find_package(BoostPython REQUIRED)
+
mtd_add_qt_tests(TARGET_NAME MantidQtScientificInterfacesTest
QT_VERSION 4
SRC ${TEST_FILES}
@@ -83,6 +88,7 @@ mtd_add_qt_tests(TARGET_NAME MantidQtScientificInterfacesTest
../../Framework/DataObjects/inc
../../Framework/TestHelpers/inc
inc
+ ${PYTHON_INCLUDE_PATH}
TEST_HELPER_SRCS
../../Framework/TestHelpers/src/ComponentCreationHelper.cpp
../../Framework/TestHelpers/src/DataProcessorTestHelper.cpp
@@ -95,6 +101,8 @@ mtd_add_qt_tests(TARGET_NAME MantidQtScientificInterfacesTest
${TCMALLOC_LIBRARIES_LINKTIME}
${CORE_MANTIDLIBS}
DataObjects
+ PythonInterfaceCore
+ ${PYTHON_LIBRARIES}
${GMOCK_LIBRARIES}
${GTEST_LIBRARIES}
${POCO_LIBRARIES}
@@ -140,8 +148,6 @@ set(QT5_TEST_FILES
test/ISISReflectometry/Common/EncoderTest.h
)
-find_package(BoostPython REQUIRED)
-
mtd_add_qt_tests(TARGET_NAME MantidQtScientificInterfacesTest
QT_VERSION 5
SRC ${QT5_TEST_FILES}
diff --git a/qt/scientific_interfaces/ISISReflectometry/GUI/Batch/AlgorithmProperties.cpp b/qt/scientific_interfaces/ISISReflectometry/GUI/Batch/AlgorithmProperties.cpp
index 67228f863ee596fcf34535723c9ec6d3a9b1110a..44971fc477773fd987aed741349c7f8053e78904 100644
--- a/qt/scientific_interfaces/ISISReflectometry/GUI/Batch/AlgorithmProperties.cpp
+++ b/qt/scientific_interfaces/ISISReflectometry/GUI/Batch/AlgorithmProperties.cpp
@@ -68,13 +68,6 @@ void updateFromMap(AlgorithmRuntimeProps &properties,
std::string getOutputWorkspace(IAlgorithm_sptr algorithm,
std::string const &property) {
auto const workspaceName = algorithm->getPropertyValue(property);
- // The workspaces are not in the ADS by default, so add them
- if (!workspaceName.empty()) {
- Workspace_sptr workspace = algorithm->getProperty(property);
- if (workspace)
- Mantid::API::AnalysisDataService::Instance().addOrReplace(workspaceName,
- workspace);
- }
return workspaceName;
}
} // namespace AlgorithmProperties
diff --git a/qt/scientific_interfaces/ISISReflectometry/GUI/Batch/QtBatchView.cpp b/qt/scientific_interfaces/ISISReflectometry/GUI/Batch/QtBatchView.cpp
index 4a4cab04611afe88cacc97ec53738dd0b89dae4c..f32f2427fedcc6af8f6ccbb111bc1fa32eabe009 100644
--- a/qt/scientific_interfaces/ISISReflectometry/GUI/Batch/QtBatchView.cpp
+++ b/qt/scientific_interfaces/ISISReflectometry/GUI/Batch/QtBatchView.cpp
@@ -130,7 +130,7 @@ std::unique_ptr<QtEventView> QtBatchView::createEventTab() {
IAlgorithm_sptr QtBatchView::createReductionAlg() {
return Mantid::API::AlgorithmManager::Instance().create(
- "ReflectometryReductionOneAuto");
+ "ReflectometryISISLoadAndProcess");
}
std::unique_ptr<QtSaveView> QtBatchView::createSaveTab() {
diff --git a/qt/scientific_interfaces/ISISReflectometry/Reduction/PerThetaDefaults.h b/qt/scientific_interfaces/ISISReflectometry/Reduction/PerThetaDefaults.h
index 88ba21b0c85fcf2bd802fbff871c0b040d350308..f4a4bb2849f14edcfac08fd226f81c2036578f6f 100644
--- a/qt/scientific_interfaces/ISISReflectometry/Reduction/PerThetaDefaults.h
+++ b/qt/scientific_interfaces/ISISReflectometry/Reduction/PerThetaDefaults.h
@@ -43,19 +43,11 @@ public:
RUN_SPECTRA = 8
};
- // The property name associated with each column. Unfortunately in
- // QtBatchView we are still using ReflectometryReductionOneAuto to get the
- // tooltips rather than ReflectometryISISLoadAndProcess. If we change it we
- // will break the Encoder and Decoder unit tests because C++ tests cannot use
- // python algorithms. The code needs to be reorganised to avoid creating the
- // algorithm, or the tests rewritten in python. This only affects tooltips
- // for a couple of the properties so is not an urgent fix, so for now just
- // make the properties here match RROA.
static auto constexpr ColumnPropertyName =
std::array<const char *, OPTIONS_TABLE_COLUMN_COUNT>{
"ThetaIn",
- "FirstTransmissionRun", // FirstTransmissionRunList in RILAP
- "SecondTransmissionRun", // SecondTransmissionRunList in RILAP
+ "FirstTransmissionRunList",
+ "SecondTransmissionRunList",
"TransmissionProcessingInstructions",
"MomentumTransferMin",
"MomentumTransferMax",
diff --git a/qt/scientific_interfaces/Indirect/CMakeLists.txt b/qt/scientific_interfaces/Indirect/CMakeLists.txt
index 015e900e8d19cdb03efc4efa87524f15f6d7f907..e90d44340aa8e0112b961cef3f95a1e5cf4fc971 100644
--- a/qt/scientific_interfaces/Indirect/CMakeLists.txt
+++ b/qt/scientific_interfaces/Indirect/CMakeLists.txt
@@ -1,631 +1,655 @@
# Qt 4 implementation
set(
- QT4_SRC_FILES
- AbsorptionCorrections.cpp
- ApplyAbsorptionCorrections.cpp
- CalculatePaalmanPings.cpp
- ContainerSubtraction.cpp
- CorrectionsTab.cpp
- ConvFit.cpp
- ConvFitAddWorkspaceDialog.cpp
- ConvFitDataPresenter.cpp
- ConvFitDataTablePresenter.cpp
- ConvFitModel.cpp
- DensityOfStates.cpp
- Elwin.cpp
- FunctionTemplateBrowser.cpp
- ILLEnergyTransfer.cpp
- ISISCalibration.cpp
- ISISDiagnostics.cpp
- ISISEnergyTransfer.cpp
- IndexTypes.cpp
- IndirectAddWorkspaceDialog.cpp
- IndirectBayes.cpp
- IndirectBayesTab.cpp
- IndirectCorrections.cpp
- IndirectDataAnalysis.cpp
- IndirectDataAnalysisTab.cpp
- IndirectDataReduction.cpp
- IndirectDataReductionTab.cpp
- IndirectDataTablePresenterLegacy.cpp
- IndirectDataTablePresenter.cpp
- IndirectDataValidationHelper.cpp
- IndirectDiffractionReduction.cpp
- IndirectEditResultsDialog.cpp
- IndirectFitAnalysisTabLegacy.cpp
- IndirectFitAnalysisTab.cpp
- IndirectFitDataLegacy.cpp
- IndirectFitDataPresenterLegacy.cpp
- IndirectFitDataViewLegacy.cpp
- IndirectFitOutputLegacy.cpp
- IndirectFitData.cpp
- IndirectFitDataPresenter.cpp
- IndirectFitDataView.cpp
- IndirectFitOutput.cpp
- IndirectFitOutputOptionsModel.cpp
- IndirectFitOutputOptionsPresenter.cpp
- IndirectFitOutputOptionsView.cpp
- IndirectFitPlotModelLegacy.cpp
- IndirectFitPlotPresenterLegacy.cpp
- IndirectFitPlotViewLegacy.cpp
- IndirectFittingModelLegacy.cpp
- IndirectFitPlotModel.cpp
- IndirectFitPlotPresenter.cpp
- IndirectFitPlotView.cpp
- IndirectFittingModel.cpp
- IndirectInstrumentConfig.cpp
- IndirectInterface.cpp
- IndirectLoadILL.cpp
- IndirectMolDyn.cpp
- IndirectMoments.cpp
- IndirectPlotOptionsModel.cpp
- IndirectPlotOptionsPresenter.cpp
- IndirectPlotOptionsView.cpp
- IndirectPlotter.cpp
- IndirectSassena.cpp
- IndirectSettings.cpp
- IndirectSettingsHelper.cpp
- IndirectSettingsModel.cpp
- IndirectSettingsPresenter.cpp
- IndirectSettingsView.cpp
- IndirectSimulation.cpp
- IndirectSimulationTab.cpp
- IndirectSpectrumSelectionPresenterLegacy.cpp
- IndirectSpectrumSelectionViewLegacy.cpp
- IndirectSpectrumSelectionPresenter.cpp
- IndirectSpectrumSelectionView.cpp
- IndirectSqw.cpp
- IndirectSymmetrise.cpp
- IndirectTab.cpp
- IndirectTools.cpp
- IndirectToolsTab.cpp
- IndirectTransmission.cpp
- IndirectTransmissionCalc.cpp
- Iqt.cpp
- IqtFit.cpp
- IqtFitModel.cpp
- IndirectFitPropertyBrowser.cpp
- IndirectFunctionBrowser/ConvTypes.cpp
- IndirectFunctionBrowser/ConvFunctionModel.cpp
- IndirectFunctionBrowser/ConvTemplateBrowser.cpp
- IndirectFunctionBrowser/ConvTemplatePresenter.cpp
- IndirectFunctionBrowser/IqtFunctionModel.cpp
- IndirectFunctionBrowser/IqtTemplateBrowser.cpp
- IndirectFunctionBrowser/IqtTemplatePresenter.cpp
- JumpFit.cpp
- JumpFitAddWorkspaceDialog.cpp
- JumpFitDataPresenter.cpp
- JumpFitDataTablePresenter.cpp
- JumpFitModel.cpp
- MSDFit.cpp
- MSDFitModel.cpp
- Quasi.cpp
- ResNorm.cpp
- Stretch.cpp
+ QT4_SRC_FILES
+ AbsorptionCorrections.cpp
+ ApplyAbsorptionCorrections.cpp
+ CalculatePaalmanPings.cpp
+ ContainerSubtraction.cpp
+ CorrectionsTab.cpp
+ ConvFit.cpp
+ ConvFitAddWorkspaceDialog.cpp
+ ConvFitDataPresenter.cpp
+ ConvFitDataTablePresenter.cpp
+ ConvFitModel.cpp
+ DensityOfStates.cpp
+ Elwin.cpp
+ FunctionTemplateBrowser.cpp
+ ILLEnergyTransfer.cpp
+ ISISCalibration.cpp
+ ISISDiagnostics.cpp
+ ISISEnergyTransfer.cpp
+ IndexTypes.cpp
+ IndirectAddWorkspaceDialog.cpp
+ IndirectBayes.cpp
+ IndirectBayesTab.cpp
+ IndirectCorrections.cpp
+ IndirectDataAnalysis.cpp
+ IndirectDataAnalysisTab.cpp
+ IndirectDataReduction.cpp
+ IndirectDataReductionTab.cpp
+ IndirectDataTablePresenterLegacy.cpp
+ IndirectDataTablePresenter.cpp
+ IndirectDataValidationHelper.cpp
+ IndirectDiffractionReduction.cpp
+ IndirectEditResultsDialog.cpp
+ IndirectFitAnalysisTabLegacy.cpp
+ IndirectFitAnalysisTab.cpp
+ IndirectFitDataLegacy.cpp
+ IndirectFitDataPresenterLegacy.cpp
+ IndirectFitDataViewLegacy.cpp
+ IndirectFitOutputLegacy.cpp
+ IndirectFitData.cpp
+ IndirectFitDataPresenter.cpp
+ IndirectFitDataView.cpp
+ IndirectFitOutput.cpp
+ IndirectFitOutputOptionsModel.cpp
+ IndirectFitOutputOptionsPresenter.cpp
+ IndirectFitOutputOptionsView.cpp
+ IndirectFitPlotModelLegacy.cpp
+ IndirectFitPlotPresenterLegacy.cpp
+ IndirectFitPlotViewLegacy.cpp
+ IndirectFittingModelLegacy.cpp
+ IndirectFitPlotModel.cpp
+ IndirectFitPlotPresenter.cpp
+ IndirectFitPlotView.cpp
+ IndirectFittingModel.cpp
+ IndirectInstrumentConfig.cpp
+ IndirectInterface.cpp
+ IndirectLoadILL.cpp
+ IndirectMolDyn.cpp
+ IndirectMoments.cpp
+ IndirectPlotOptionsModel.cpp
+ IndirectPlotOptionsPresenter.cpp
+ IndirectPlotOptionsView.cpp
+ IndirectPlotter.cpp
+ IndirectSassena.cpp
+ IndirectSettings.cpp
+ IndirectSettingsHelper.cpp
+ IndirectSettingsModel.cpp
+ IndirectSettingsPresenter.cpp
+ IndirectSettingsView.cpp
+ IndirectSimulation.cpp
+ IndirectSimulationTab.cpp
+ IndirectSpectrumSelectionPresenterLegacy.cpp
+ IndirectSpectrumSelectionViewLegacy.cpp
+ IndirectSpectrumSelectionPresenter.cpp
+ IndirectSpectrumSelectionView.cpp
+ IndirectSqw.cpp
+ IndirectSymmetrise.cpp
+ IndirectTab.cpp
+ IndirectTools.cpp
+ IndirectToolsTab.cpp
+ IndirectTransmission.cpp
+ IndirectTransmissionCalc.cpp
+ Iqt.cpp
+ IqtFit.cpp
+ IqtFitModel.cpp
+ IndirectFitPropertyBrowser.cpp
+ IndirectFunctionBrowser/ConvTypes.cpp
+ IndirectFunctionBrowser/ConvFunctionModel.cpp
+ IndirectFunctionBrowser/ConvTemplateBrowser.cpp
+ IndirectFunctionBrowser/ConvTemplatePresenter.cpp
+ IndirectFunctionBrowser/IqtFunctionModel.cpp
+ IndirectFunctionBrowser/IqtTemplateBrowser.cpp
+ IndirectFunctionBrowser/IqtTemplatePresenter.cpp
+ IndirectFunctionBrowser/MSDFunctionModel.cpp
+ IndirectFunctionBrowser/MSDTemplateBrowser.cpp
+ IndirectFunctionBrowser/MSDTemplatePresenter.cpp
+ IndirectFunctionBrowser/FQFunctionModel.cpp
+ IndirectFunctionBrowser/FQTemplateBrowser.cpp
+ IndirectFunctionBrowser/FQTemplatePresenter.cpp
+ JumpFit.cpp
+ JumpFitAddWorkspaceDialog.cpp
+ JumpFitDataPresenter.cpp
+ JumpFitDataTablePresenter.cpp
+ JumpFitModel.cpp
+ MSDFit.cpp
+ MSDFitModel.cpp
+ Quasi.cpp
+ ResNorm.cpp
+ Stretch.cpp
)
# Include files aren't required, but this makes them appear in Visual Studio
# IMPORTANT: Include files are required in the QT4_MOC_FILES set. Scroll down to
# find it.
set(
- QT4_INC_FILES
- ConvFitModel.h
- DllConfig.h
- IndexTypes.h
- IndirectDataValidationHelper.h
- IndirectFitDataLegacy.h
- IndirectFitOutputLegacy.h
- IndirectFitData.h
- IndirectFitOutput.h
- IndirectFitOutputOptionsModel.h
- IndirectFitPlotModelLegacy.h
- IndirectFitPlotPresenterLegacy.h
- IndirectFittingModelLegacy.h
- IndirectFitPlotModel.h
- IndirectFitPlotPresenter.h
- IndirectFittingModel.h
- IndirectPlotOptionsModel.h
- IndirectSettingsHelper.h
- IndirectToolsTab.h
- IPythonRunner.h
- IqtFitModel.h
- IndirectFunctionBrowser/ConvFunctionModel.h
- JumpFitModel.h
- MSDFitModel.h
- ParameterEstimation.h
+ QT4_INC_FILES
+ ConvFitModel.h
+ DllConfig.h
+ IndexTypes.h
+ IndirectDataValidationHelper.h
+ IndirectFitDataLegacy.h
+ IndirectFitOutputLegacy.h
+ IndirectFitData.h
+ IndirectFitOutput.h
+ IndirectFitOutputOptionsModel.h
+ IndirectFitPlotModelLegacy.h
+ IndirectFitPlotPresenterLegacy.h
+ IndirectFittingModelLegacy.h
+ IndirectFitPlotModel.h
+ IndirectFitPlotPresenter.h
+ IndirectFittingModel.h
+ IndirectPlotOptionsModel.h
+ IndirectSettingsHelper.h
+ IndirectToolsTab.h
+ IPythonRunner.h
+ IqtFitModel.h
+ IndirectFunctionBrowser/ConvFunctionModel.h
+ IndirectFunctionBrowser/IqtFunctionModel.h
+ IndirectFunctionBrowser/MSDFunctionModel.h
+ JumpFitModel.h
+ MSDFitModel.h
+ Notifier.h
+ IFQFitObserver.h
+ ParameterEstimation.h
)
set(
- QT4_MOC_FILES
- AbsorptionCorrections.h
- ApplyAbsorptionCorrections.h
- CalculatePaalmanPings.h
- ContainerSubtraction.h
- ConvFitAddWorkspaceDialog.h
- ConvFitDataPresenter.h
- ConvFitDataTablePresenter.h
- ConvFit.h
- CorrectionsTab.h
- DensityOfStates.h
- Elwin.h
- FunctionTemplateBrowser.h
- IAddWorkspaceDialog.h
- IIndirectFitDataViewLegacy.h
- IIndirectFitDataView.h
- IIndirectFitOutputOptionsView.h
- IIndirectFitPlotViewLegacy.h
- IIndirectFitPlotView.h
- IIndirectSettingsView.h
- ILLEnergyTransfer.h
- IndirectAddWorkspaceDialog.h
- IndirectBayes.h
- IndirectBayesTab.h
- IndirectCorrections.h
- IndirectDataAnalysis.h
- IndirectDataAnalysisTab.h
- IndirectDataReduction.h
- IndirectDataReductionTab.h
- IndirectDataTablePresenterLegacy.h
- IndirectDataTablePresenter.h
- IndirectDiffractionReduction.h
- IndirectEditResultsDialog.h
- IndirectFitAnalysisTabLegacy.h
- IndirectFitAnalysisTab.h
- IndirectFitDataPresenterLegacy.h
- IndirectFitDataViewLegacy.h
- IndirectFitDataPresenter.h
- IndirectFitDataView.h
- IndirectFitOutputOptionsPresenter.h
- IndirectFitOutputOptionsView.h
- IndirectFitPlotPresenterLegacy.h
- IndirectFitPlotViewLegacy.h
- IndirectFitPlotPresenter.h
- IndirectFitPlotView.h
- IndirectInstrumentConfig.h
- IndirectInterface.h
- IndirectLoadILL.h
- IndirectMolDyn.h
- IndirectMoments.h
- IndirectPlotOptionsPresenter.h
- IndirectPlotOptionsView.h
- IndirectPlotter.h
- IndirectSassena.h
- IndirectSettings.h
- IndirectSettingsPresenter.h
- IndirectSettingsView.h
- IndirectSimulation.h
- IndirectSimulationTab.h
- IndirectSpectrumSelectionPresenterLegacy.h
- IndirectSpectrumSelectionViewLegacy.h
- IndirectSpectrumSelectionPresenter.h
- IndirectSpectrumSelectionView.h
- IndirectSqw.h
- IndirectSymmetrise.h
- IndirectTab.h
- IndirectTools.h
- IndirectToolsTab.h
- IndirectTransmissionCalc.h
- IndirectTransmission.h
- IqtFit.h
- IndirectFunctionBrowser/ConvTemplateBrowser.h
- IndirectFunctionBrowser/ConvTemplatePresenter.h
- IndirectFunctionBrowser/IqtTemplateBrowser.h
- IndirectFunctionBrowser/IqtTemplatePresenter.h
- IndirectFunctionBrowser/IqtTemplateBrowser.h
- IndirectFunctionBrowser/IqtTemplatePresenter.h
- IndirectFitPropertyBrowser.h
- Iqt.h
- ISISCalibration.h
- ISISDiagnostics.h
- ISISEnergyTransfer.h
- JumpFitAddWorkspaceDialog.h
- JumpFitDataPresenter.h
- JumpFitDataTablePresenter.h
- JumpFit.h
- LazyAsyncRunner.h
- MSDFit.h
- Quasi.h
- ResNorm.h
- Stretch.h
+ QT4_MOC_FILES
+ AbsorptionCorrections.h
+ ApplyAbsorptionCorrections.h
+ CalculatePaalmanPings.h
+ ContainerSubtraction.h
+ ConvFitAddWorkspaceDialog.h
+ ConvFitDataPresenter.h
+ ConvFitDataTablePresenter.h
+ ConvFit.h
+ CorrectionsTab.h
+ DensityOfStates.h
+ Elwin.h
+ FunctionTemplateBrowser.h
+ IAddWorkspaceDialog.h
+ IIndirectFitDataViewLegacy.h
+ IIndirectFitDataView.h
+ IIndirectFitOutputOptionsView.h
+ IIndirectFitPlotViewLegacy.h
+ IIndirectFitPlotView.h
+ IIndirectSettingsView.h
+ ILLEnergyTransfer.h
+ IndirectAddWorkspaceDialog.h
+ IndirectBayes.h
+ IndirectBayesTab.h
+ IndirectCorrections.h
+ IndirectDataAnalysis.h
+ IndirectDataAnalysisTab.h
+ IndirectDataReduction.h
+ IndirectDataReductionTab.h
+ IndirectDataTablePresenterLegacy.h
+ IndirectDataTablePresenter.h
+ IndirectDiffractionReduction.h
+ IndirectEditResultsDialog.h
+ IndirectFitAnalysisTabLegacy.h
+ IndirectFitAnalysisTab.h
+ IndirectFitDataPresenterLegacy.h
+ IndirectFitDataViewLegacy.h
+ IndirectFitDataPresenter.h
+ IndirectFitDataView.h
+ IndirectFitOutputOptionsPresenter.h
+ IndirectFitOutputOptionsView.h
+ IndirectFitPlotPresenterLegacy.h
+ IndirectFitPlotViewLegacy.h
+ IndirectFitPlotPresenter.h
+ IndirectFitPlotView.h
+ IndirectInstrumentConfig.h
+ IndirectInterface.h
+ IndirectLoadILL.h
+ IndirectMolDyn.h
+ IndirectMoments.h
+ IndirectPlotOptionsPresenter.h
+ IndirectPlotOptionsView.h
+ IndirectPlotter.h
+ IndirectSassena.h
+ IndirectSettings.h
+ IndirectSettingsPresenter.h
+ IndirectSettingsView.h
+ IndirectSimulation.h
+ IndirectSimulationTab.h
+ IndirectSpectrumSelectionPresenterLegacy.h
+ IndirectSpectrumSelectionViewLegacy.h
+ IndirectSpectrumSelectionPresenter.h
+ IndirectSpectrumSelectionView.h
+ IndirectSqw.h
+ IndirectSymmetrise.h
+ IndirectTab.h
+ IndirectTools.h
+ IndirectToolsTab.h
+ IndirectTransmissionCalc.h
+ IndirectTransmission.h
+ IqtFit.h
+ IndirectFunctionBrowser/ConvTemplateBrowser.h
+ IndirectFunctionBrowser/ConvTemplatePresenter.h
+ IndirectFunctionBrowser/IqtTemplateBrowser.h
+ IndirectFunctionBrowser/IqtTemplatePresenter.h
+ IndirectFunctionBrowser/MSDTemplateBrowser.h
+ IndirectFunctionBrowser/MSDTemplatePresenter.h
+ IndirectFunctionBrowser/FQTemplateBrowser.h
+ IndirectFunctionBrowser/FQTemplatePresenter.h
+ IndirectFitPropertyBrowser.h
+ Iqt.h
+ ISISCalibration.h
+ ISISDiagnostics.h
+ ISISEnergyTransfer.h
+ JumpFitAddWorkspaceDialog.h
+ JumpFitDataPresenter.h
+ JumpFitDataTablePresenter.h
+ JumpFit.h
+ LazyAsyncRunner.h
+ MSDFit.h
+ Quasi.h
+ ResNorm.h
+ Stretch.h
)
set(
- QT4_UI_FILES
- AbsorptionCorrections.ui
- ApplyAbsorptionCorrections.ui
- CalculatePaalmanPings.ui
- ContainerSubtraction.ui
- ConvFit.ui
- ConvFitAddWorkspaceDialog.ui
- DensityOfStates.ui
- Elwin.ui
- ILLEnergyTransfer.ui
- IndirectAddWorkspaceDialog.ui
- IndirectBayes.ui
- IndirectCorrections.ui
- IndirectDataAnalysis.ui
- IndirectDataReduction.ui
- IndirectDiffractionReduction.ui
- IndirectEditResultsDialog.ui
- IndirectFitDataViewLegacy.ui
- IndirectFitDataView.ui
- IndirectFitOutputOptions.ui
- IndirectFitPreviewPlot.ui
- IndirectInterfaceSettings.ui
- IndirectInstrumentConfig.ui
- IndirectLoadILL.ui
- IndirectMolDyn.ui
- IndirectMoments.ui
- IndirectPlotOptions.ui
- IndirectSassena.ui
- IndirectSettings.ui
- IndirectSimulation.ui
- IndirectSpectrumSelector.ui
- IndirectSqw.ui
- IndirectSymmetrise.ui
- IndirectTools.ui
- IndirectTransmission.ui
- IndirectTransmissionCalc.ui
- Iqt.ui
- IqtFit.ui
- JumpFit.ui
- JumpFitAddWorkspaceDialog.ui
- MSDFit.ui
- Quasi.ui
- ResNorm.ui
- Stretch.ui
- ISISCalibration.ui
- ISISDiagnostics.ui
- ISISEnergyTransfer.ui
+ QT4_UI_FILES
+ AbsorptionCorrections.ui
+ ApplyAbsorptionCorrections.ui
+ CalculatePaalmanPings.ui
+ ContainerSubtraction.ui
+ ConvFit.ui
+ ConvFitAddWorkspaceDialog.ui
+ DensityOfStates.ui
+ Elwin.ui
+ ILLEnergyTransfer.ui
+ IndirectAddWorkspaceDialog.ui
+ IndirectBayes.ui
+ IndirectCorrections.ui
+ IndirectDataAnalysis.ui
+ IndirectDataReduction.ui
+ IndirectDiffractionReduction.ui
+ IndirectEditResultsDialog.ui
+ IndirectFitDataViewLegacy.ui
+ IndirectFitDataView.ui
+ IndirectFitOutputOptions.ui
+ IndirectFitPreviewPlot.ui
+ IndirectInterfaceSettings.ui
+ IndirectInstrumentConfig.ui
+ IndirectLoadILL.ui
+ IndirectMolDyn.ui
+ IndirectMoments.ui
+ IndirectPlotOptions.ui
+ IndirectSassena.ui
+ IndirectSettings.ui
+ IndirectSimulation.ui
+ IndirectSpectrumSelector.ui
+ IndirectSqw.ui
+ IndirectSymmetrise.ui
+ IndirectTools.ui
+ IndirectTransmission.ui
+ IndirectTransmissionCalc.ui
+ Iqt.ui
+ IqtFit.ui
+ JumpFit.ui
+ JumpFitAddWorkspaceDialog.ui
+ MSDFit.ui
+ Quasi.ui
+ ResNorm.ui
+ Stretch.ui
+ ISISCalibration.ui
+ ISISDiagnostics.ui
+ ISISEnergyTransfer.ui
)
set(QT4_RES_FILES IndirectInterfaceResources.qrc)
mtd_add_qt_library(
- TARGET_NAME MantidScientificInterfacesIndirect
- QT_VERSION 4
- SRC ${QT4_SRC_FILES}
- MOC ${QT4_MOC_FILES}
- NOMOC ${QT4_INC_FILES}
- UI ${QT4_UI_FILES}
- RES ${QT4_RES_FILES}
- DEFS
- IN_MANTIDQT_INDIRECT
- PRECOMPILED
- PrecompiledHeader.h
- INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}
- SYSTEM_INCLUDE_DIRS ${Boost_INCLUDE_DIRS}
- LINK_LIBS
- ${TCMALLOC_LIBRARIES_LINKTIME}
- ${CORE_MANTIDLIBS}
- ${POCO_LIBRARIES}
- ${Boost_LIBRARIES}
- ${JSONCPP_LIBRARIES}
- QT4_LINK_LIBS
- Qwt5
- Qt4::QtXml
- MTD_QT_LINK_LIBS
- MantidQtWidgetsCommon
- MantidQtWidgetsPlotting
- MantidScientificInterfacesGeneral
- INSTALL_DIR_BASE ${PLUGINS_DIR}
- OSX_INSTALL_RPATH
- @loader_path/../../Contents/MacOS
- @loader_path/../../Contents/Frameworks
- @loader_path/../../plugins/qt4
- LINUX_INSTALL_RPATH "\$ORIGIN/../../${LIB_DIR};\$ORIGIN/../../plugins/qt4/"
+ TARGET_NAME MantidScientificInterfacesIndirect
+ QT_VERSION 4
+ SRC ${QT4_SRC_FILES}
+ MOC ${QT4_MOC_FILES}
+ NOMOC ${QT4_INC_FILES}
+ UI ${QT4_UI_FILES}
+ RES ${QT4_RES_FILES}
+ DEFS
+ IN_MANTIDQT_INDIRECT
+ PRECOMPILED
+ PrecompiledHeader.h
+ INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}
+ SYSTEM_INCLUDE_DIRS ${Boost_INCLUDE_DIRS}
+ LINK_LIBS
+ ${TCMALLOC_LIBRARIES_LINKTIME}
+ ${CORE_MANTIDLIBS}
+ ${POCO_LIBRARIES}
+ ${Boost_LIBRARIES}
+ ${JSONCPP_LIBRARIES}
+ QT4_LINK_LIBS
+ Qwt5
+ Qt4::QtXml
+ MTD_QT_LINK_LIBS
+ MantidQtWidgetsCommon
+ MantidQtWidgetsPlotting
+ MantidScientificInterfacesGeneral
+ INSTALL_DIR_BASE ${PLUGINS_DIR}
+ OSX_INSTALL_RPATH
+ @loader_path/../../Contents/MacOS
+ @loader_path/../../Contents/Frameworks
+ @loader_path/../../plugins/qt4
+ LINUX_INSTALL_RPATH "\$ORIGIN/../../${LIB_DIR};\$ORIGIN/../../plugins/qt4/"
)
# Qt 5 implementation
set(
- SRC_FILES
- AbsorptionCorrections.cpp
- ApplyAbsorptionCorrections.cpp
- CalculatePaalmanPings.cpp
- ContainerSubtraction.cpp
- CorrectionsTab.cpp
- ConvFit.cpp
- ConvFitAddWorkspaceDialog.cpp
- ConvFitDataPresenter.cpp
- ConvFitDataTablePresenter.cpp
- ConvFitModel.cpp
- DensityOfStates.cpp
- Elwin.cpp
- FunctionTemplateBrowser.cpp
- ILLEnergyTransfer.cpp
- ISISCalibration.cpp
- ISISDiagnostics.cpp
- ISISEnergyTransfer.cpp
- IndirectAddWorkspaceDialog.cpp
- IndirectBayes.cpp
- IndirectBayesTab.cpp
- IndirectCorrections.cpp
- IndirectDataAnalysis.cpp
- IndirectDataAnalysisTab.cpp
- IndirectDataReduction.cpp
- IndirectDataReductionTab.cpp
- IndirectDataTablePresenter.cpp
- IndirectDataTablePresenterLegacy.cpp
- IndirectDataValidationHelper.cpp
- IndirectDiffractionReduction.cpp
- IndirectEditResultsDialog.cpp
- IndirectFitAnalysisTab.cpp
- IndirectFitAnalysisTabLegacy.cpp
- IndirectFitData.cpp
- IndirectFitDataLegacy.cpp
- IndirectFitDataPresenter.cpp
- IndirectFitDataPresenterLegacy.cpp
- IndirectFitDataView.cpp
- IndirectFitDataViewLegacy.cpp
- IndirectFitOutput.cpp
- IndirectFitOutputLegacy.cpp
- IndirectFitOutputOptionsModel.cpp
- IndirectFitOutputOptionsPresenter.cpp
- IndirectFitOutputOptionsView.cpp
- IndirectFitPropertyBrowser.cpp
- IndirectFitPlotModel.cpp
- IndirectFitPlotModelLegacy.cpp
- IndirectFitPlotPresenter.cpp
- IndirectFitPlotPresenterLegacy.cpp
- IndirectFitPlotView.cpp
- IndirectFitPlotViewLegacy.cpp
- IndirectFittingModel.cpp
- IndirectFittingModelLegacy.cpp
- IndirectInstrumentConfig.cpp
- IndirectInterface.cpp
- IndirectLoadILL.cpp
- IndirectMolDyn.cpp
- IndirectMoments.cpp
- IndirectPlotOptionsModel.cpp
- IndirectPlotOptionsPresenter.cpp
- IndirectPlotOptionsView.cpp
- IndirectPlotter.cpp
- IndirectSassena.cpp
- IndirectSettings.cpp
- IndirectSettingsHelper.cpp
- IndirectSettingsModel.cpp
- IndirectSettingsPresenter.cpp
- IndirectSettingsView.cpp
- IndirectSimulation.cpp
- IndirectSimulationTab.cpp
- IndirectSpectrumSelectionPresenter.cpp
- IndirectSpectrumSelectionPresenterLegacy.cpp
- IndirectSpectrumSelectionView.cpp
- IndirectSpectrumSelectionViewLegacy.cpp
- IndirectSqw.cpp
- IndirectSymmetrise.cpp
- IndirectTab.cpp
- IndirectTools.cpp
- IndirectToolsTab.cpp
- IndirectTransmission.cpp
- IndirectTransmissionCalc.cpp
- Iqt.cpp
- IqtFit.cpp
- IqtFitModel.cpp
- IndirectFunctionBrowser/ConvTypes.cpp
- IndirectFunctionBrowser/ConvFunctionModel.cpp
- IndirectFunctionBrowser/ConvTemplateBrowser.cpp
- IndirectFunctionBrowser/ConvTemplatePresenter.cpp
- IndirectFunctionBrowser/IqtFunctionModel.cpp
- IndirectFunctionBrowser/IqtTemplateBrowser.cpp
- IndirectFunctionBrowser/IqtTemplatePresenter.cpp
- JumpFit.cpp
- JumpFitAddWorkspaceDialog.cpp
- JumpFitDataPresenter.cpp
- JumpFitDataTablePresenter.cpp
- JumpFitModel.cpp
- MSDFit.cpp
- MSDFitModel.cpp
- Quasi.cpp
- ResNorm.cpp
- Stretch.cpp
+ SRC_FILES
+ AbsorptionCorrections.cpp
+ ApplyAbsorptionCorrections.cpp
+ CalculatePaalmanPings.cpp
+ ContainerSubtraction.cpp
+ CorrectionsTab.cpp
+ ConvFit.cpp
+ ConvFitAddWorkspaceDialog.cpp
+ ConvFitDataPresenter.cpp
+ ConvFitDataTablePresenter.cpp
+ ConvFitModel.cpp
+ DensityOfStates.cpp
+ Elwin.cpp
+ FunctionTemplateBrowser.cpp
+ ILLEnergyTransfer.cpp
+ ISISCalibration.cpp
+ ISISDiagnostics.cpp
+ ISISEnergyTransfer.cpp
+ IndirectAddWorkspaceDialog.cpp
+ IndirectBayes.cpp
+ IndirectBayesTab.cpp
+ IndirectCorrections.cpp
+ IndirectDataAnalysis.cpp
+ IndirectDataAnalysisTab.cpp
+ IndirectDataReduction.cpp
+ IndirectDataReductionTab.cpp
+ IndirectDataTablePresenter.cpp
+ IndirectDataTablePresenterLegacy.cpp
+ IndirectDataValidationHelper.cpp
+ IndirectDiffractionReduction.cpp
+ IndirectEditResultsDialog.cpp
+ IndirectFitAnalysisTab.cpp
+ IndirectFitAnalysisTabLegacy.cpp
+ IndirectFitData.cpp
+ IndirectFitDataLegacy.cpp
+ IndirectFitDataPresenter.cpp
+ IndirectFitDataPresenterLegacy.cpp
+ IndirectFitDataView.cpp
+ IndirectFitDataViewLegacy.cpp
+ IndirectFitOutput.cpp
+ IndirectFitOutputLegacy.cpp
+ IndirectFitOutputOptionsModel.cpp
+ IndirectFitOutputOptionsPresenter.cpp
+ IndirectFitOutputOptionsView.cpp
+ IndirectFitPropertyBrowser.cpp
+ IndirectFitPlotModel.cpp
+ IndirectFitPlotModelLegacy.cpp
+ IndirectFitPlotPresenter.cpp
+ IndirectFitPlotPresenterLegacy.cpp
+ IndirectFitPlotView.cpp
+ IndirectFitPlotViewLegacy.cpp
+ IndirectFittingModel.cpp
+ IndirectFittingModelLegacy.cpp
+ IndirectInstrumentConfig.cpp
+ IndirectInterface.cpp
+ IndirectLoadILL.cpp
+ IndirectMolDyn.cpp
+ IndirectMoments.cpp
+ IndirectPlotOptionsModel.cpp
+ IndirectPlotOptionsPresenter.cpp
+ IndirectPlotOptionsView.cpp
+ IndirectPlotter.cpp
+ IndirectSassena.cpp
+ IndirectSettings.cpp
+ IndirectSettingsHelper.cpp
+ IndirectSettingsModel.cpp
+ IndirectSettingsPresenter.cpp
+ IndirectSettingsView.cpp
+ IndirectSimulation.cpp
+ IndirectSimulationTab.cpp
+ IndirectSpectrumSelectionPresenter.cpp
+ IndirectSpectrumSelectionPresenterLegacy.cpp
+ IndirectSpectrumSelectionView.cpp
+ IndirectSpectrumSelectionViewLegacy.cpp
+ IndirectSqw.cpp
+ IndirectSymmetrise.cpp
+ IndirectTab.cpp
+ IndirectTools.cpp
+ IndirectToolsTab.cpp
+ IndirectTransmission.cpp
+ IndirectTransmissionCalc.cpp
+ Iqt.cpp
+ IqtFit.cpp
+ IqtFitModel.cpp
+ IndirectFunctionBrowser/ConvTypes.cpp
+ IndirectFunctionBrowser/ConvFunctionModel.cpp
+ IndirectFunctionBrowser/ConvTemplateBrowser.cpp
+ IndirectFunctionBrowser/ConvTemplatePresenter.cpp
+ IndirectFunctionBrowser/IqtFunctionModel.cpp
+ IndirectFunctionBrowser/IqtTemplateBrowser.cpp
+ IndirectFunctionBrowser/IqtTemplatePresenter.cpp
+ IndirectFunctionBrowser/MSDFunctionModel.cpp
+ IndirectFunctionBrowser/MSDTemplateBrowser.cpp
+ IndirectFunctionBrowser/MSDTemplatePresenter.cpp
+ IndirectFunctionBrowser/FQFunctionModel.cpp
+ IndirectFunctionBrowser/FQTemplateBrowser.cpp
+ IndirectFunctionBrowser/FQTemplatePresenter.cpp
+ JumpFit.cpp
+ JumpFitAddWorkspaceDialog.cpp
+ JumpFitDataPresenter.cpp
+ JumpFitDataTablePresenter.cpp
+ JumpFitModel.cpp
+ MSDFit.cpp
+ MSDFitModel.cpp
+ Quasi.cpp
+ ResNorm.cpp
+ Stretch.cpp
)
set(
- MOC_FILES
- AbsorptionCorrections.h
- ApplyAbsorptionCorrections.h
- CalculatePaalmanPings.h
- ContainerSubtraction.h
- ConvFitAddWorkspaceDialog.h
- ConvFitDataPresenter.h
- ConvFitDataTablePresenter.h
- ConvFit.h
- CorrectionsTab.h
- DensityOfStates.h
- Elwin.h
- FunctionTemplateBrowser.h
- ILLEnergyTransfer.h
- ISISCalibration.h
- ISISDiagnostics.h
- ISISEnergyTransfer.h
- IAddWorkspaceDialog.h
- IIndirectFitDataView.h
- IIndirectFitDataViewLegacy.h
- IIndirectFitOutputOptionsView.h
- IIndirectFitPlotView.h
- IIndirectFitPlotViewLegacy.h
- IIndirectSettingsView.h
- IndirectAddWorkspaceDialog.h
- IndirectBayes.h
- IndirectBayesTab.h
- IndirectCorrections.h
- IndirectDataAnalysis.h
- IndirectDataAnalysisTab.h
- IndirectDataReduction.h
- IndirectDataReductionTab.h
- IndirectDataTablePresenter.h
- IndirectDataTablePresenterLegacy.h
- IndirectDiffractionReduction.h
- IndirectEditResultsDialog.h
- IndirectFitAnalysisTab.h
- IndirectFitAnalysisTabLegacy.h
- IndirectFitDataPresenter.h
- IndirectFitDataPresenterLegacy.h
- IndirectFitDataView.h
- IndirectFitDataViewLegacy.h
- IndirectFitOutputOptionsPresenter.h
- IndirectFitOutputOptionsView.h
- IndirectFitPropertyBrowser.h
- IndirectFitPlotPresenter.h
- IndirectFitPlotPresenterLegacy.h
- IndirectFitPlotView.h
- IndirectFitPlotViewLegacy.h
- IndirectInstrumentConfig.h
- IndirectInterface.h
- IndirectLoadILL.h
- IndirectMolDyn.h
- IndirectMoments.h
- IndirectPlotOptionsPresenter.h
- IndirectPlotOptionsView.h
- IndirectPlotter.h
- IndirectSassena.h
- IndirectSettings.h
- IndirectSettingsPresenter.h
- IndirectSettingsView.h
- IndirectSimulation.h
- IndirectSimulationTab.h
- IndirectSpectrumSelectionPresenter.h
- IndirectSpectrumSelectionPresenterLegacy.h
- IndirectSpectrumSelectionView.h
- IndirectSpectrumSelectionViewLegacy.h
- IndirectSqw.h
- IndirectSymmetrise.h
- IndirectTab.h
- IndirectTools.h
- IndirectToolsTab.h
- IndirectTransmission.h
- IndirectTransmissionCalc.h
- IqtFit.h
- IndirectFunctionBrowser/ConvTemplateBrowser.h
- IndirectFunctionBrowser/ConvTemplatePresenter.h
- IndirectFunctionBrowser/IqtTemplateBrowser.h
- IndirectFunctionBrowser/IqtTemplatePresenter.h
- Iqt.h
- JumpFitAddWorkspaceDialog.h
- JumpFitDataPresenter.h
- JumpFitDataTablePresenter.h
- JumpFit.h
- LazyAsyncRunner.h
- MSDFit.h
- Quasi.h
- ResNorm.h
- Stretch.h
+ MOC_FILES
+ AbsorptionCorrections.h
+ ApplyAbsorptionCorrections.h
+ CalculatePaalmanPings.h
+ ContainerSubtraction.h
+ ConvFitAddWorkspaceDialog.h
+ ConvFitDataPresenter.h
+ ConvFitDataTablePresenter.h
+ ConvFit.h
+ CorrectionsTab.h
+ DensityOfStates.h
+ Elwin.h
+ FunctionTemplateBrowser.h
+ ILLEnergyTransfer.h
+ ISISCalibration.h
+ ISISDiagnostics.h
+ ISISEnergyTransfer.h
+ IAddWorkspaceDialog.h
+ IIndirectFitDataView.h
+ IIndirectFitDataViewLegacy.h
+ IIndirectFitOutputOptionsView.h
+ IIndirectFitPlotView.h
+ IIndirectFitPlotViewLegacy.h
+ IIndirectSettingsView.h
+ IndirectAddWorkspaceDialog.h
+ IndirectBayes.h
+ IndirectBayesTab.h
+ IndirectCorrections.h
+ IndirectDataAnalysis.h
+ IndirectDataAnalysisTab.h
+ IndirectDataReduction.h
+ IndirectDataReductionTab.h
+ IndirectDataTablePresenter.h
+ IndirectDataTablePresenterLegacy.h
+ IndirectDiffractionReduction.h
+ IndirectEditResultsDialog.h
+ IndirectFitAnalysisTab.h
+ IndirectFitAnalysisTabLegacy.h
+ IndirectFitDataPresenter.h
+ IndirectFitDataPresenterLegacy.h
+ IndirectFitDataView.h
+ IndirectFitDataViewLegacy.h
+ IndirectFitOutputOptionsPresenter.h
+ IndirectFitOutputOptionsView.h
+ IndirectFitPropertyBrowser.h
+ IndirectFitPlotPresenter.h
+ IndirectFitPlotPresenterLegacy.h
+ IndirectFitPlotView.h
+ IndirectFitPlotViewLegacy.h
+ IndirectInstrumentConfig.h
+ IndirectInterface.h
+ IndirectLoadILL.h
+ IndirectMolDyn.h
+ IndirectMoments.h
+ IndirectPlotOptionsPresenter.h
+ IndirectPlotOptionsView.h
+ IndirectPlotter.h
+ IndirectSassena.h
+ IndirectSettings.h
+ IndirectSettingsPresenter.h
+ IndirectSettingsView.h
+ IndirectSimulation.h
+ IndirectSimulationTab.h
+ IndirectSpectrumSelectionPresenter.h
+ IndirectSpectrumSelectionPresenterLegacy.h
+ IndirectSpectrumSelectionView.h
+ IndirectSpectrumSelectionViewLegacy.h
+ IndirectSqw.h
+ IndirectSymmetrise.h
+ IndirectTab.h
+ IndirectTools.h
+ IndirectToolsTab.h
+ IndirectTransmission.h
+ IndirectTransmissionCalc.h
+ IqtFit.h
+ IndirectFunctionBrowser/ConvTemplateBrowser.h
+ IndirectFunctionBrowser/ConvTemplatePresenter.h
+ IndirectFunctionBrowser/IqtTemplateBrowser.h
+ IndirectFunctionBrowser/IqtTemplatePresenter.h
+ IndirectFunctionBrowser/MSDTemplateBrowser.h
+ IndirectFunctionBrowser/MSDTemplatePresenter.h
+ IndirectFunctionBrowser/FQTemplateBrowser.h
+ IndirectFunctionBrowser/FQTemplatePresenter.h
+ Iqt.h
+ JumpFitAddWorkspaceDialog.h
+ JumpFitDataPresenter.h
+ JumpFitDataTablePresenter.h
+ JumpFit.h
+ LazyAsyncRunner.h
+ MSDFit.h
+ Quasi.h
+ ResNorm.h
+ Stretch.h
)
set(
- INC_FILES
- ConvFitModel.h
- IndirectDataValidationHelper.h
- IndirectFitData.h
- IndirectFitDataLegacy.h
- IndirectFitOutput.h
- IndirectFitOutputLegacy.h
- IndirectFitOutputOptionsModel.h
- IndirectFitPlotModel.h
- IndirectFitPlotModelLegacy.h
- IndirectFitPlotPresenter.h
- IndirectFitPlotPresenterLegacy.h
- IndirectFittingModel.h
- IndirectFittingModelLegacy.h
- IndirectPlotOptionsModel.h
- IndirectSettingsHelper.h
- IPythonRunner.h
- IqtFitModel.h
- IndirectFunctionBrowser/ConvFunctionModel.h
- JumpFitModel.h
- MSDFitModel.h
+ INC_FILES
+ ConvFitModel.h
+ IndirectDataValidationHelper.h
+ IndirectFitData.h
+ IndirectFitDataLegacy.h
+ IndirectFitOutput.h
+ IndirectFitOutputLegacy.h
+ IndirectFitOutputOptionsModel.h
+ IndirectFitPlotModel.h
+ IndirectFitPlotModelLegacy.h
+ IndirectFitPlotPresenter.h
+ IndirectFitPlotPresenterLegacy.h
+ IndirectFittingModel.h
+ IndirectFittingModelLegacy.h
+ IndirectPlotOptionsModel.h
+ IndirectSettingsHelper.h
+ IPythonRunner.h
+ IqtFitModel.h
+ IndirectFunctionBrowser/ConvFunctionModel.h
+ JumpFitModel.h
+ MSDFitModel.h
+ Notifier.h
+ IFQFitObserver.h
)
set(
- UI_FILES
- AbsorptionCorrections.ui
- ApplyAbsorptionCorrections.ui
- CalculatePaalmanPings.ui
- ContainerSubtraction.ui
- ConvFit.ui
- ConvFitAddWorkspaceDialog.ui
- DensityOfStates.ui
- Elwin.ui
- ILLEnergyTransfer.ui
- ISISCalibration.ui
- ISISDiagnostics.ui
- ISISEnergyTransfer.ui
- IndirectAddWorkspaceDialog.ui
- IndirectBayes.ui
- IndirectCorrections.ui
- IndirectDataAnalysis.ui
- IndirectDataReduction.ui
- IndirectDiffractionReduction.ui
- IndirectEditResultsDialog.ui
- IndirectFitDataView.ui
- IndirectFitOutputOptions.ui
- IndirectFitPreviewPlot.ui
- IndirectInstrumentConfig.ui
- IndirectInterfaceSettings.ui
- IndirectLoadILL.ui
- IndirectMolDyn.ui
- IndirectMoments.ui
- IndirectPlotOptions.ui
- IndirectSassena.ui
- IndirectSettings.ui
- IndirectSimulation.ui
- IndirectSpectrumSelector.ui
- IndirectSqw.ui
- IndirectSymmetrise.ui
- IndirectTools.ui
- IndirectTransmission.ui
- IndirectTransmissionCalc.ui
- Iqt.ui
- IqtFit.ui
- JumpFit.ui
- JumpFitAddWorkspaceDialog.ui
- MSDFit.ui
- Quasi.ui
- ResNorm.ui
- Stretch.ui
+ UI_FILES
+ AbsorptionCorrections.ui
+ ApplyAbsorptionCorrections.ui
+ CalculatePaalmanPings.ui
+ ContainerSubtraction.ui
+ ConvFit.ui
+ ConvFitAddWorkspaceDialog.ui
+ DensityOfStates.ui
+ Elwin.ui
+ ILLEnergyTransfer.ui
+ ISISCalibration.ui
+ ISISDiagnostics.ui
+ ISISEnergyTransfer.ui
+ IndirectAddWorkspaceDialog.ui
+ IndirectBayes.ui
+ IndirectCorrections.ui
+ IndirectDataAnalysis.ui
+ IndirectDataReduction.ui
+ IndirectDiffractionReduction.ui
+ IndirectEditResultsDialog.ui
+ IndirectFitDataView.ui
+ IndirectFitOutputOptions.ui
+ IndirectFitPreviewPlot.ui
+ IndirectInstrumentConfig.ui
+ IndirectInterfaceSettings.ui
+ IndirectLoadILL.ui
+ IndirectMolDyn.ui
+ IndirectMoments.ui
+ IndirectPlotOptions.ui
+ IndirectSassena.ui
+ IndirectSettings.ui
+ IndirectSimulation.ui
+ IndirectSpectrumSelector.ui
+ IndirectSqw.ui
+ IndirectSymmetrise.ui
+ IndirectTools.ui
+ IndirectTransmission.ui
+ IndirectTransmissionCalc.ui
+ Iqt.ui
+ IqtFit.ui
+ JumpFit.ui
+ JumpFitAddWorkspaceDialog.ui
+ MSDFit.ui
+ Quasi.ui
+ ResNorm.ui
+ Stretch.ui
)
set(RES_FILES IndirectInterfaceResources.qrc)
-if(ENABLE_WORKBENCH)
- # XML is required to parse the settings file
- find_package(Qt5 COMPONENTS Concurrent Xml REQUIRED)
-endif()
+if (ENABLE_WORKBENCH)
+ # XML is required to parse the settings file
+ find_package(Qt5 COMPONENTS Concurrent Xml REQUIRED)
+endif ()
mtd_add_qt_library(
- TARGET_NAME MantidScientificInterfacesIndirect
- QT_VERSION 5
- SRC ${SRC_FILES}
- MOC ${MOC_FILES}
- NOMOC ${INC_FILES}
- UI ${UI_FILES}
- RES ${RES_FILES}
- DEFS
- IN_MANTIDQT_INDIRECT
- PRECOMPILED
- PrecompiledHeader.h
- INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}
- LINK_LIBS
- ${TCMALLOC_LIBRARIES_LINKTIME}
- ${CORE_MANTIDLIBS}
- PythonInterfaceCore
- ${POCO_LIBRARIES}
- ${Boost_LIBRARIES}
- ${PYTHON_LIBRARIES}
- Qt5::Concurrent
- Qt5::Xml
- MTD_QT_LINK_LIBS
- MantidQtWidgetsCommon
- MantidQtWidgetsPlotting
- MantidQtWidgetsMplCpp
- MantidQtIcons
- INSTALL_DIR_BASE
- ${WORKBENCH_PLUGINS_DIR}
- OSX_INSTALL_RPATH
- @loader_path/../../Contents/MacOS
- @loader_path/../../Contents/Frameworks
- @loader_path/../../plugins/qt5
- LINUX_INSTALL_RPATH "\$ORIGIN/../../${LIB_DIR};\$ORIGIN/../../plugins/qt5/"
+ TARGET_NAME MantidScientificInterfacesIndirect
+ QT_VERSION 5
+ SRC ${SRC_FILES}
+ MOC ${MOC_FILES}
+ NOMOC ${INC_FILES}
+ UI ${UI_FILES}
+ RES ${RES_FILES}
+ DEFS
+ IN_MANTIDQT_INDIRECT
+ PRECOMPILED
+ PrecompiledHeader.h
+ INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}
+ LINK_LIBS
+ ${TCMALLOC_LIBRARIES_LINKTIME}
+ ${CORE_MANTIDLIBS}
+ PythonInterfaceCore
+ ${POCO_LIBRARIES}
+ ${Boost_LIBRARIES}
+ ${PYTHON_LIBRARIES}
+ Qt5::Concurrent
+ Qt5::Xml
+ MTD_QT_LINK_LIBS
+ MantidQtWidgetsCommon
+ MantidQtWidgetsPlotting
+ MantidQtWidgetsMplCpp
+ MantidQtIcons
+ INSTALL_DIR_BASE
+ ${WORKBENCH_PLUGINS_DIR}
+ OSX_INSTALL_RPATH
+ @loader_path/../../Contents/MacOS
+ @loader_path/../../Contents/Frameworks
+ @loader_path/../../plugins/qt5
+ LINUX_INSTALL_RPATH "\$ORIGIN/../../${LIB_DIR};\$ORIGIN/../../plugins/qt5/"
)
# Testing target
diff --git a/qt/scientific_interfaces/Indirect/FunctionTemplateBrowser.h b/qt/scientific_interfaces/Indirect/FunctionTemplateBrowser.h
index 9fc821f88a9760377d4d7bf88fe027fdb5a67c9c..772424328a8bad97b5b8f4705faa88f481a4492c 100644
--- a/qt/scientific_interfaces/Indirect/FunctionTemplateBrowser.h
+++ b/qt/scientific_interfaces/Indirect/FunctionTemplateBrowser.h
@@ -41,6 +41,7 @@ class MANTIDQT_INDIRECT_DLL FunctionTemplateBrowser : public QWidget {
Q_OBJECT
public:
FunctionTemplateBrowser(QWidget *parent);
+ virtual ~FunctionTemplateBrowser() = default;
void init();
virtual void setFunction(const QString &funStr) = 0;
diff --git a/qt/scientific_interfaces/Indirect/IFQFitObserver.h b/qt/scientific_interfaces/Indirect/IFQFitObserver.h
new file mode 100644
index 0000000000000000000000000000000000000000..049ff3520fd60ee066025693486e6dffe679d634
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IFQFitObserver.h
@@ -0,0 +1,22 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef MANTIDQTCUSTOMINTERFACES_IFQFITOBSERVER_H_
+#define MANTIDQTCUSTOMINTERFACES_IFQFITOBSERVER_H_
+
+enum DataType {
+ WIDTH,
+ EISF,
+};
+
+class IFQFitObserver {
+public:
+ virtual ~IFQFitObserver() = default;
+ virtual void updateDataType(DataType) = 0;
+ virtual void spectrumChanged(int) = 0;
+};
+
+#endif
diff --git a/qt/scientific_interfaces/Indirect/IIndirectFitPlotView.h b/qt/scientific_interfaces/Indirect/IIndirectFitPlotView.h
index 1ae037978479cf95df97bedb76b958376d680511..2761481051a2b8223691f35beec84a5dcfea4694 100644
--- a/qt/scientific_interfaces/Indirect/IIndirectFitPlotView.h
+++ b/qt/scientific_interfaces/Indirect/IIndirectFitPlotView.h
@@ -79,6 +79,7 @@ public:
virtual void setHWHMRangeVisible(bool visible) = 0;
virtual void displayMessage(const std::string &message) const = 0;
+ virtual void disableSpectrumPlotSelection() = 0;
public slots:
virtual void clearTopPreview() = 0;
diff --git a/qt/scientific_interfaces/Indirect/IndirectDataAnalysisTab.h b/qt/scientific_interfaces/Indirect/IndirectDataAnalysisTab.h
index d683bbdb469caac3b4f2a698182a807f661c5aed..7f8f4240c93984bdc7275a6d5be1ed869323040d 100644
--- a/qt/scientific_interfaces/Indirect/IndirectDataAnalysisTab.h
+++ b/qt/scientific_interfaces/Indirect/IndirectDataAnalysisTab.h
@@ -59,6 +59,7 @@ class MANTIDQT_INDIRECT_DLL IndirectDataAnalysisTab : public IndirectTab {
public:
/// Constructor
IndirectDataAnalysisTab(QWidget *parent = nullptr);
+ virtual ~IndirectDataAnalysisTab() override = default;
/// Set the presenter for the output plotting options
void setOutputPlotOptionsPresenter(
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitAnalysisTab.cpp b/qt/scientific_interfaces/Indirect/IndirectFitAnalysisTab.cpp
index 1d212bef607a35e95d0c31b3d471c9742b8bb8d6..665dee88a8ae31de40a8a0eda70f2bc66350e032 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitAnalysisTab.cpp
+++ b/qt/scientific_interfaces/Indirect/IndirectFitAnalysisTab.cpp
@@ -159,6 +159,7 @@ void IndirectFitAnalysisTab::setFitDataPresenter(
void IndirectFitAnalysisTab::setPlotView(IIndirectFitPlotView *view) {
m_plotPresenter = std::make_unique<IndirectFitPlotPresenter>(
m_fittingModel.get(), view, this);
+ m_plotPresenter->disableSpectrumPlotSelection();
}
void IndirectFitAnalysisTab::setSpectrumSelectionView(
@@ -696,9 +697,9 @@ QStringList IndirectFitAnalysisTab::getDatasetNames() const {
TableDatasetIndex index{i};
auto const name =
QString::fromStdString(m_fittingModel->getWorkspace(index)->getName());
- auto const numberSpectra = m_fittingModel->getNumberOfSpectra(index);
- for (int j{0}; j < numberSpectra.value; ++j) {
- datasetNames << name + " (" + QString::number(j) + ")";
+ auto const spectra = m_fittingModel->getSpectra(index);
+ for (auto spectrum : spectra) {
+ datasetNames << name + " (" + QString::number(spectrum.value) + ")";
}
}
return datasetNames;
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitAnalysisTab.h b/qt/scientific_interfaces/Indirect/IndirectFitAnalysisTab.h
index d14726ec4464cc7876846e8e6a4f9d0e4a1d06a3..127cb2718073f9847e9c7cc4c10bc5cc8ea7d8fa 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitAnalysisTab.h
+++ b/qt/scientific_interfaces/Indirect/IndirectFitAnalysisTab.h
@@ -38,6 +38,7 @@ class MANTIDQT_INDIRECT_DLL IndirectFitAnalysisTab
public:
IndirectFitAnalysisTab(IndirectFittingModel *model,
QWidget *parent = nullptr);
+ virtual ~IndirectFitAnalysisTab() override = default;
void setFitDataPresenter(std::unique_ptr<IndirectFitDataPresenter> presenter);
void setPlotView(IIndirectFitPlotView *view);
@@ -79,6 +80,8 @@ protected:
virtual void setRunIsRunning(bool running) = 0;
virtual void setRunEnabled(bool enable) = 0;
void setEditResultVisible(bool visible);
+ std::unique_ptr<IndirectFitDataPresenter> m_dataPresenter;
+ std::unique_ptr<IndirectFitPlotPresenter> m_plotPresenter;
signals:
void functionChanged();
@@ -154,8 +157,6 @@ private:
void updateParameterEstimationData();
std::unique_ptr<IndirectFittingModel> m_fittingModel;
- std::unique_ptr<IndirectFitDataPresenter> m_dataPresenter;
- std::unique_ptr<IndirectFitPlotPresenter> m_plotPresenter;
std::unique_ptr<IndirectSpectrumSelectionPresenter> m_spectrumPresenter;
std::unique_ptr<IndirectFitOutputOptionsPresenter> m_outOptionsPresenter;
IndirectFitPropertyBrowser *m_fitPropertyBrowser{nullptr};
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitDataPresenter.cpp b/qt/scientific_interfaces/Indirect/IndirectFitDataPresenter.cpp
index 88120298666741b88cf6d63504d657c8d93864c2..1f97fd0f015e1bbe00cb56008543033bded60adb 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitDataPresenter.cpp
+++ b/qt/scientific_interfaces/Indirect/IndirectFitDataPresenter.cpp
@@ -35,9 +35,7 @@ IndirectFitDataPresenter::IndirectFitDataPresenter(
SIGNAL(multipleDataViewSelected()));
connect(m_view, SIGNAL(sampleLoaded(const QString &)), this,
- SLOT(setModelWorkspace(const QString &)));
- connect(m_view, SIGNAL(sampleLoaded(const QString &)), this,
- SIGNAL(dataChanged()));
+ SLOT(handleSampleLoaded(const QString &)));
connect(m_view, SIGNAL(addClicked()), this,
SIGNAL(requestedAddWorkspaceDialog()));
@@ -182,6 +180,14 @@ void IndirectFitDataPresenter::setResolutionHidden(bool hide) {
m_view->setResolutionHidden(hide);
}
+void IndirectFitDataPresenter::handleSampleLoaded(
+ const QString &workspaceName) {
+ setModelWorkspace(workspaceName);
+ emit dataChanged();
+ updateRanges();
+ emit dataChanged();
+}
+
void IndirectFitDataPresenter::setModelWorkspace(const QString &name) {
observeReplace(false);
setSingleModelData(name.toStdString());
@@ -272,6 +278,9 @@ void IndirectFitDataPresenter::addDataToModel(
void IndirectFitDataPresenter::setSingleModelData(const std::string &name) {
m_model->clearWorkspaces();
addModelData(name);
+}
+
+void IndirectFitDataPresenter::updateRanges() {
auto const dataIndex = TableDatasetIndex{0};
auto const spectra = m_model->getSpectra(dataIndex);
if (!spectra.empty()) {
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitDataPresenter.h b/qt/scientific_interfaces/Indirect/IndirectFitDataPresenter.h
index d667d776c8140d9085028665515ef8cb8bfa6f4a..e64c750c1e0a651c2e512e9b2f10aa4c2e775dc7 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitDataPresenter.h
+++ b/qt/scientific_interfaces/Indirect/IndirectFitDataPresenter.h
@@ -93,12 +93,14 @@ protected:
void addData(IAddWorkspaceDialog const *dialog);
virtual void addDataToModel(IAddWorkspaceDialog const *dialog);
void setSingleModelData(const std::string &name);
+ void updateRanges();
virtual void addModelData(const std::string &name);
void setResolutionHidden(bool hide);
void displayWarning(const std::string &warning);
private slots:
void addData();
+ void handleSampleLoaded(const QString &);
private:
virtual std::unique_ptr<IAddWorkspaceDialog>
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitPlotPresenter.cpp b/qt/scientific_interfaces/Indirect/IndirectFitPlotPresenter.cpp
index 0d660ea07b7a9c5f2868e2150b37a1bc3ca65096..3d50ebebfe16afc282e74ed4e29a94135c772820 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitPlotPresenter.cpp
+++ b/qt/scientific_interfaces/Indirect/IndirectFitPlotPresenter.cpp
@@ -59,13 +59,7 @@ IndirectFitPlotPresenter::IndirectFitPlotPresenter(IndirectFittingModel *model,
SIGNAL(selectedFitDataChanged(TableDatasetIndex)));
connect(m_view, SIGNAL(plotSpectrumChanged(WorkspaceIndex)), this,
- SLOT(setActiveSpectrum(WorkspaceIndex)));
- connect(m_view, SIGNAL(plotSpectrumChanged(WorkspaceIndex)), this,
- SLOT(updatePlots()));
- connect(m_view, SIGNAL(plotSpectrumChanged(WorkspaceIndex)), this,
- SLOT(updateFitRangeSelector()));
- connect(m_view, SIGNAL(plotSpectrumChanged(WorkspaceIndex)), this,
- SIGNAL(plotSpectrumChanged(WorkspaceIndex)));
+ SLOT(handlePlotSpectrumChanged(WorkspaceIndex)));
connect(m_view, SIGNAL(plotCurrentPreview()), this,
SLOT(plotCurrentPreview()));
@@ -103,6 +97,14 @@ IndirectFitPlotPresenter::IndirectFitPlotPresenter(IndirectFittingModel *model,
updateAvailableSpectra();
}
+void IndirectFitPlotPresenter::handlePlotSpectrumChanged(
+ WorkspaceIndex spectrum) {
+ setActiveSpectrum(spectrum);
+ updatePlots();
+ updateFitRangeSelector();
+ emit plotSpectrumChanged(spectrum);
+}
+
void IndirectFitPlotPresenter::watchADS(bool watch) { m_view->watchADS(watch); }
TableDatasetIndex IndirectFitPlotPresenter::getSelectedDataIndex() const {
@@ -133,6 +135,11 @@ void IndirectFitPlotPresenter::setActiveIndex(TableDatasetIndex index) {
void IndirectFitPlotPresenter::setActiveSpectrum(WorkspaceIndex spectrum) {
m_model->setActiveSpectrum(spectrum);
+ m_view->setPlotSpectrum(spectrum);
+}
+
+void IndirectFitPlotPresenter::disableSpectrumPlotSelection() {
+ m_view->disableSpectrumPlotSelection();
}
void IndirectFitPlotPresenter::setModelStartX(double startX) {
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitPlotPresenter.h b/qt/scientific_interfaces/Indirect/IndirectFitPlotPresenter.h
index 9463c46ab30724997b44883e7bc2672dbe778adf..fc9c4928a40ae5fc2145bb8f566714cb4feb196f 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitPlotPresenter.h
+++ b/qt/scientific_interfaces/Indirect/IndirectFitPlotPresenter.h
@@ -56,6 +56,8 @@ public slots:
void updateGuessAvailability();
void enablePlotGuessInSeparateWindow();
void disablePlotGuessInSeparateWindow();
+ void disableSpectrumPlotSelection();
+ void handlePlotSpectrumChanged(WorkspaceIndex spectrum);
signals:
void selectedFitDataChanged(TableDatasetIndex /*_t1*/);
@@ -74,7 +76,6 @@ private slots:
void setModelHWHM(double minimum, double maximum);
void setModelBackground(double background);
void setActiveIndex(TableDatasetIndex index);
- void setActiveSpectrum(WorkspaceIndex spectrum);
void setHWHMMaximum(double minimum);
void setHWHMMinimum(double maximum);
void plotGuess(bool doPlotGuess);
@@ -82,6 +83,7 @@ private slots:
void plotCurrentPreview();
void emitFitSingleSpectrum();
void emitFWHMChanged(double minimum, double maximum);
+ void setActiveSpectrum(WorkspaceIndex spectrum);
private:
void disableAllDataSelection();
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitPlotView.cpp b/qt/scientific_interfaces/Indirect/IndirectFitPlotView.cpp
index 999cb46052dbe0f97cca3e54a01c6f2f3c467859..8ba9a6a9546448b3ad9f0bfb2b8ed5c62b51fff9 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitPlotView.cpp
+++ b/qt/scientific_interfaces/Indirect/IndirectFitPlotView.cpp
@@ -207,7 +207,16 @@ void IndirectFitPlotView::setMaximumSpectrum(int maximum) {
void IndirectFitPlotView::setPlotSpectrum(WorkspaceIndex spectrum) {
MantidQt::API::SignalBlocker blocker(m_plotForm->spPlotSpectrum);
+ MantidQt::API::SignalBlocker comboBlocker(m_plotForm->cbPlotSpectrum);
m_plotForm->spPlotSpectrum->setValue(spectrum.value);
+ auto index =
+ m_plotForm->cbPlotSpectrum->findText(QString::number(spectrum.value));
+ m_plotForm->cbPlotSpectrum->setCurrentIndex(index);
+}
+
+void IndirectFitPlotView::disableSpectrumPlotSelection() {
+ m_plotForm->spPlotSpectrum->setEnabled(false);
+ m_plotForm->cbPlotSpectrum->setEnabled(false);
}
void IndirectFitPlotView::setBackgroundLevel(double value) {
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitPlotView.h b/qt/scientific_interfaces/Indirect/IndirectFitPlotView.h
index f9959e22f9ab78527074b291b6d1936671951799..97e481bc272b4f07d734a469011b9239ca2f3447 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitPlotView.h
+++ b/qt/scientific_interfaces/Indirect/IndirectFitPlotView.h
@@ -120,6 +120,7 @@ public:
void setHWHMRangeVisible(bool visible) override;
void displayMessage(const std::string &message) const override;
+ void disableSpectrumPlotSelection() override;
public slots:
void clearTopPreview() override;
diff --git a/qt/scientific_interfaces/Indirect/IndirectFitPropertyBrowser.h b/qt/scientific_interfaces/Indirect/IndirectFitPropertyBrowser.h
index b26bbabdfb658c183e67f5d6a7dc84c95a0284ce..f97c9141811099477515ec32817f7c0a834803bb 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFitPropertyBrowser.h
+++ b/qt/scientific_interfaces/Indirect/IndirectFitPropertyBrowser.h
@@ -15,7 +15,6 @@
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include <QDockWidget>
-
#include <boost/optional.hpp>
#include <unordered_map>
@@ -41,6 +40,7 @@ class MANTIDQT_INDIRECT_DLL IndirectFitPropertyBrowser : public QDockWidget {
public:
IndirectFitPropertyBrowser(QWidget *parent = nullptr);
+
void init();
void setFunctionTemplateBrowser(FunctionTemplateBrowser *templateBrowser);
void setFunction(const QString &funStr);
diff --git a/qt/scientific_interfaces/Indirect/IndirectFittingModel.cpp b/qt/scientific_interfaces/Indirect/IndirectFittingModel.cpp
index caf078364b7e7dd204fc6726ba6e47956ff38d1e..b994f79507e6312dc8c53bfd0bf35a51261e746c 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFittingModel.cpp
+++ b/qt/scientific_interfaces/Indirect/IndirectFittingModel.cpp
@@ -309,6 +309,11 @@ namespace MantidQt {
namespace CustomInterfaces {
namespace IDA {
+std::unordered_map<FittingMode, std::string> fitModeToName =
+ std::unordered_map<FittingMode, std::string>(
+ {{FittingMode::SEQUENTIAL, "Sequential"},
+ {FittingMode::SIMULTANEOUS, "Simultaneous"}});
+
PrivateFittingData::PrivateFittingData() : m_data() {}
PrivateFittingData::PrivateFittingData(PrivateFittingData &&privateData)
diff --git a/qt/scientific_interfaces/Indirect/IndirectFittingModel.h b/qt/scientific_interfaces/Indirect/IndirectFittingModel.h
index 2ef1dce77d893c0c83adca2b6755964eb8921550..e107feab699cb66bfa19368a01d806cda1ae6c31 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFittingModel.h
+++ b/qt/scientific_interfaces/Indirect/IndirectFittingModel.h
@@ -24,6 +24,7 @@ namespace CustomInterfaces {
namespace IDA {
enum class FittingMode { SEQUENTIAL, SIMULTANEOUS };
+extern std::unordered_map<FittingMode, std::string> fitModeToName;
class IndirectFittingModel;
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQFunctionModel.cpp b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQFunctionModel.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..da240e854af69737f07103cb253f0bc4c8374e5e
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQFunctionModel.cpp
@@ -0,0 +1,103 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "FQFunctionModel.h"
+#include "MantidAPI/FunctionFactory.h"
+#include "MantidAPI/IFunction.h"
+#include "MantidAPI/ITableWorkspace.h"
+#include "MantidAPI/MultiDomainFunction.h"
+#include "MantidQtWidgets/Common/FunctionBrowser/FunctionBrowserUtils.h"
+#include <unordered_map>
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+using namespace MantidWidgets;
+using namespace Mantid::API;
+
+QStringList widthFits = QStringList(
+ {"None", "ChudleyElliot", "HallRoss", "FickDiffusion", "TeixeiraWater"});
+
+QStringList eisfFits = QStringList(
+ {"None", "EISFDiffCylinder", "EISFDiffSphere", "EISFDiffSphereAlkyl"});
+
+std::unordered_map<DataType, QStringList> dataTypeFitTypeMap(
+ {{DataType::WIDTH, widthFits}, {DataType::EISF, eisfFits}});
+
+FQFunctionModel::FQFunctionModel() {
+ for (auto functionName : widthFits + eisfFits) {
+ if (functionName == "None")
+ continue;
+ auto function =
+ FunctionFactory::Instance().createFunction(functionName.toStdString());
+ m_functionStore.insert(functionName, function);
+ m_globalParameterStore.insert(functionName, QStringList());
+ }
+ m_fitType = "None";
+ m_dataType = DataType::WIDTH;
+}
+
+QStringList FQFunctionModel::getFunctionList() {
+ return dataTypeFitTypeMap.at(m_dataType);
+}
+
+int FQFunctionModel::getEnumIndex() {
+ return dataTypeFitTypeMap.at(m_dataType).indexOf(m_fitType);
+}
+
+void FQFunctionModel::setFunction(IFunction_sptr fun) {
+ if (!fun)
+ return;
+ if (fun->nFunctions() == 0) {
+ const auto name = fun->name();
+ const auto &functionNameList = dataTypeFitTypeMap.at(m_dataType);
+ if (functionNameList.contains(QString::fromStdString(name))) {
+ setFitType(QString::fromStdString(name));
+ } else {
+ throw std::runtime_error("Cannot set function " + name);
+ }
+ } else {
+ throw std::runtime_error("Function has wrong structure.");
+ }
+}
+
+void FQFunctionModel::setDataType(DataType dataType) { m_dataType = dataType; }
+
+void FQFunctionModel::setFitType(const QString &name) {
+ if (m_function) {
+ m_globalParameterStore[m_fitType] = getGlobalParameters();
+ }
+ m_fitType = name;
+ if (name == "None") {
+ clear();
+ return;
+ }
+ setGlobalParameters(m_globalParameterStore[name]);
+ FunctionModel::setFunction(m_functionStore[name]->clone());
+}
+
+QString FQFunctionModel::getFitType() { return m_fitType; }
+
+void FQFunctionModel::updateParameterEstimationData(
+ DataForParameterEstimationCollection &&data) {
+ m_estimationData = std::move(data);
+}
+
+void FQFunctionModel::setGlobal(const QString &name, bool isGlobal) {
+ auto globalParameters = getGlobalParameters();
+ if (isGlobal && !globalParameters.contains(name)) {
+ globalParameters << name;
+ } else if (!isGlobal && globalParameters.contains(name)) {
+ globalParameters.removeAll(name);
+ }
+ globalParameters.removeDuplicates();
+ setGlobalParameters(globalParameters);
+}
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
\ No newline at end of file
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQFunctionModel.h b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQFunctionModel.h
new file mode 100644
index 0000000000000000000000000000000000000000..6c1a7b47d8ccc4fb9be46c7dd21eb16bab823d5f
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQFunctionModel.h
@@ -0,0 +1,59 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+
+#ifndef MANTID_FQFUNCTIONMODEL_H
+#define MANTID_FQFUNCTIONMODEL_H
+
+#include "DllConfig.h"
+#include "IFQFitObserver.h"
+#include "IndexTypes.h"
+#include "MantidAPI/IFunction_fwd.h"
+#include "MantidAPI/ITableWorkspace_fwd.h"
+#include "MantidQtWidgets/Common/FunctionModel.h"
+#include "ParameterEstimation.h"
+
+#include <QMap>
+#include <boost/optional.hpp>
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+using namespace Mantid::API;
+using namespace MantidWidgets;
+
+class MANTIDQT_INDIRECT_DLL FQFunctionModel : public FunctionModel {
+public:
+ FQFunctionModel();
+ void setFunction(IFunction_sptr fun) override;
+
+ void setFitType(const QString &name);
+ QString getFitType();
+ void removeFitType();
+ void setDataType(DataType dataType);
+ QStringList getFunctionList();
+ int getEnumIndex();
+ void setGlobal(const QString &name, bool isGlobal);
+
+ void
+ updateParameterEstimationData(DataForParameterEstimationCollection &&data);
+
+private:
+ QString m_fitType;
+ DataForParameterEstimationCollection m_estimationData;
+ QMap<QString, IFunction_sptr> m_functionStore;
+ QMap<QString, QStringList> m_globalParameterStore;
+ std::string m_resolutionName;
+ TableDatasetIndex m_resolutionIndex;
+ DataType m_dataType;
+};
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
+
+#endif // MANTID_FQFUNCTIONMODEL_H
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplateBrowser.cpp b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplateBrowser.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..7e6ec9c6ed5de604b601962bfd5a64f31699b361
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplateBrowser.cpp
@@ -0,0 +1,224 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "FQTemplateBrowser.h"
+
+#include "MantidAPI/CostFunctionFactory.h"
+#include "MantidAPI/FuncMinimizerFactory.h"
+#include "MantidAPI/IAlgorithm.h"
+#include "MantidAPI/IFuncMinimizer.h"
+#include "MantidAPI/ITableWorkspace.h"
+#include "MantidAPI/IWorkspaceProperty.h"
+#include "MantidKernel/PropertyWithValue.h"
+
+#include "MantidQtWidgets/Common/FunctionBrowser/FunctionBrowserUtils.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/ButtonEditorFactory.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/CompositeEditorFactory.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/DoubleEditorFactory.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/qteditorfactory.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/qtpropertymanager.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/qttreepropertybrowser.h"
+
+#include <QMessageBox>
+#include <QSettings>
+#include <QVBoxLayout>
+
+#include <limits>
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+/**
+ * Constructor
+ * @param parent :: The parent widget.
+ */
+FQTemplateBrowser::FQTemplateBrowser(QWidget *parent)
+ : FunctionTemplateBrowser(parent), m_presenter(this) {
+ connect(&m_presenter, SIGNAL(functionStructureChanged()), this,
+ SIGNAL(functionStructureChanged()));
+}
+
+void FQTemplateBrowser::createProperties() {
+ m_parameterManager->blockSignals(true);
+ m_boolManager->blockSignals(true);
+ m_enumManager->blockSignals(true);
+
+ m_fitType = m_enumManager->addProperty("Fit Type");
+ m_browser->addProperty(m_fitType);
+ updateDataType(DataType::WIDTH);
+
+ m_parameterManager->blockSignals(false);
+ m_enumManager->blockSignals(false);
+ m_boolManager->blockSignals(false);
+}
+
+void FQTemplateBrowser::setDataType(QStringList allowedFunctionsList) {
+ ScopedFalse _false(m_emitEnumChange);
+ m_enumManager->setEnumNames(m_fitType, allowedFunctionsList);
+ m_enumManager->setValue(m_fitType, 0);
+}
+
+void FQTemplateBrowser::setEnumValue(int enumIndex) {
+ ScopedFalse _false(m_emitEnumChange);
+ m_enumManager->setValue(m_fitType, enumIndex);
+}
+
+void FQTemplateBrowser::addParameter(QString parameterName,
+ QString parameterDescription) {
+ auto newParameter = m_parameterManager->addProperty(parameterName);
+ m_parameterManager->setDescription(newParameter,
+ parameterDescription.toStdString());
+ m_parameterManager->setDecimals(newParameter, 6);
+ m_fitType->addSubProperty(newParameter);
+ m_parameterMap.insert(parameterName, newParameter);
+ m_parameterNames.insert(newParameter, parameterName);
+}
+
+int FQTemplateBrowser::getCurrentDataset() {
+ return m_presenter.getCurrentDataset();
+}
+
+void FQTemplateBrowser::setFunction(const QString &funStr) {
+ m_presenter.setFunction(funStr);
+}
+
+IFunction_sptr FQTemplateBrowser::getGlobalFunction() const {
+ return m_presenter.getGlobalFunction();
+}
+
+IFunction_sptr FQTemplateBrowser::getFunction() const {
+ return m_presenter.getFunction();
+}
+
+void FQTemplateBrowser::setNumberOfDatasets(int n) {
+ m_presenter.setNumberOfDatasets(n);
+}
+
+int FQTemplateBrowser::getNumberOfDatasets() const {
+ return m_presenter.getNumberOfDatasets();
+}
+
+void FQTemplateBrowser::setDatasetNames(const QStringList &names) {
+ m_presenter.setDatasetNames(names);
+}
+
+QStringList FQTemplateBrowser::getGlobalParameters() const {
+ return m_presenter.getGlobalParameters();
+}
+
+QStringList FQTemplateBrowser::getLocalParameters() const {
+ return m_presenter.getLocalParameters();
+}
+
+void FQTemplateBrowser::setGlobalParameters(const QStringList &globals) {
+ m_presenter.setGlobalParameters(globals);
+}
+
+void FQTemplateBrowser::enumChanged(QtProperty *prop) {
+ if (!m_emitEnumChange)
+ return;
+ if (prop == m_fitType) {
+ auto fitType = m_enumManager->enumNames(prop)[m_enumManager->value(prop)];
+ m_presenter.setFitType(fitType);
+ }
+}
+
+void FQTemplateBrowser::globalChanged(QtProperty *, const QString &, bool) {}
+
+void FQTemplateBrowser::parameterChanged(QtProperty *prop) {
+ auto isGlobal = m_parameterManager->isGlobal(prop);
+ m_presenter.setGlobal(m_parameterNames[prop], isGlobal);
+ if (m_emitParameterValueChange) {
+ emit parameterValueChanged(m_parameterNames[prop],
+ m_parameterManager->value(prop));
+ }
+}
+
+void FQTemplateBrowser::parameterButtonClicked(QtProperty *prop) {
+ emit localParameterButtonClicked(m_parameterNames[prop]);
+}
+
+void FQTemplateBrowser::updateMultiDatasetParameters(const IFunction &fun) {
+ m_presenter.updateMultiDatasetParameters(fun);
+}
+
+void FQTemplateBrowser::updateMultiDatasetParameters(const ITableWorkspace &) {}
+
+void FQTemplateBrowser::updateParameters(const IFunction &fun) {
+ m_presenter.updateParameters(fun);
+}
+
+void FQTemplateBrowser::setParameterValue(QString parameterName,
+ double parameterValue,
+ double parameterError) {
+ m_parameterManager->setValue(m_parameterMap[parameterName], parameterValue);
+ m_parameterManager->setError(m_parameterMap[parameterName], parameterError);
+}
+
+void FQTemplateBrowser::setCurrentDataset(int i) {
+ m_presenter.setCurrentDataset(i);
+}
+
+void FQTemplateBrowser::updateParameterNames(const QMap<int, QString> &) {}
+
+void FQTemplateBrowser::updateParameterDescriptions(
+ const QMap<int, std::string> &) {}
+
+void FQTemplateBrowser::setErrorsEnabled(bool enabled) {
+ ScopedFalse _false(m_emitParameterValueChange);
+ m_parameterManager->setErrorsEnabled(enabled);
+}
+
+void FQTemplateBrowser::clear() {
+ m_parameterManager->clear();
+ m_parameterMap.clear();
+ m_parameterNames.clear();
+}
+
+void FQTemplateBrowser::updateParameterEstimationData(
+ DataForParameterEstimationCollection &&data) {
+ m_presenter.updateParameterEstimationData(std::move(data));
+}
+
+void FQTemplateBrowser::popupMenu(const QPoint &) {}
+
+void FQTemplateBrowser::setParameterPropertyValue(QtProperty *prop,
+ double value, double error) {
+ if (prop) {
+ ScopedFalse _false(m_emitParameterValueChange);
+ m_parameterManager->setValue(prop, value);
+ m_parameterManager->setError(prop, error);
+ }
+}
+
+void FQTemplateBrowser::setGlobalParametersQuiet(const QStringList &globals) {
+ ScopedFalse _false(m_emitParameterValueChange);
+ for (auto ¶meterName : m_parameterMap.keys()) {
+ if (globals.contains(parameterName)) {
+ m_parameterManager->setGlobal(m_parameterMap[parameterName], true);
+ } else {
+ m_parameterManager->setGlobal(m_parameterMap[parameterName], false);
+ }
+ }
+}
+
+void FQTemplateBrowser::setBackgroundA0(double) {}
+void FQTemplateBrowser::setResolution(std::string const &,
+ TableDatasetIndex const &) {}
+void FQTemplateBrowser::setResolution(
+ const std::vector<std::pair<std::string, int>> &) {}
+void FQTemplateBrowser::setQValues(const std::vector<double> &) {}
+
+void FQTemplateBrowser::updateDataType(DataType dataType) {
+ emit dataTypeChanged(dataType);
+}
+
+void FQTemplateBrowser::spectrumChanged(int) {}
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
\ No newline at end of file
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplateBrowser.h b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplateBrowser.h
new file mode 100644
index 0000000000000000000000000000000000000000..240a04db853460cc0b6e795374a2858848d9242a
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplateBrowser.h
@@ -0,0 +1,100 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef INDIRECT_FQTEMPLATEBROWSER_H_
+#define INDIRECT_FQTEMPLATEBROWSER_H_
+
+#include "DllConfig.h"
+#include "FQTemplatePresenter.h"
+#include "FunctionTemplateBrowser.h"
+#include "IFQFitObserver.h"
+
+#include <QMap>
+#include <QWidget>
+
+class QtProperty;
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+/**
+ * Class FunctionTemplateBrowser implements QtPropertyBrowser to display
+ * and set properties that can be used to generate a fit function.
+ *
+ */
+class MANTIDQT_INDIRECT_DLL FQTemplateBrowser : public FunctionTemplateBrowser,
+ public IFQFitObserver {
+ Q_OBJECT
+public:
+ explicit FQTemplateBrowser(QWidget *parent = nullptr);
+ virtual ~FQTemplateBrowser() = default;
+
+ void setFunction(const QString &funStr) override;
+ IFunction_sptr getGlobalFunction() const override;
+ IFunction_sptr getFunction() const override;
+ void setNumberOfDatasets(int) override;
+ int getNumberOfDatasets() const override;
+ void setDatasetNames(const QStringList &names) override;
+ QStringList getGlobalParameters() const override;
+ QStringList getLocalParameters() const override;
+ void setGlobalParameters(const QStringList &globals) override;
+ void updateMultiDatasetParameters(const IFunction &fun) override;
+ void updateMultiDatasetParameters(const ITableWorkspace ¶mTable) override;
+ void updateParameters(const IFunction &fun) override;
+ void setCurrentDataset(int i) override;
+ void updateParameterNames(const QMap<int, QString> ¶meterNames) override;
+ void
+ updateParameterDescriptions(const QMap<int, std::string> ¶meterNames);
+ void setErrorsEnabled(bool enabled) override;
+ void clear() override;
+ void updateParameterEstimationData(
+ DataForParameterEstimationCollection &&data) override;
+ void setBackgroundA0(double) override;
+ void setResolution(std::string const &, TableDatasetIndex const &) override;
+ void setResolution(const std::vector<std::pair<std::string, int>> &) override;
+ void setQValues(const std::vector<double> &) override;
+ int getCurrentDataset() override;
+ void updateDataType(DataType) override;
+ void spectrumChanged(int) override;
+ void addParameter(QString parameterName, QString parameterDescription);
+ void setParameterValue(QString parameterName, double parameterValue,
+ double parameterError);
+ void setDataType(QStringList allowedFunctionsList);
+ void setEnumValue(int enumIndex);
+
+signals:
+ void dataTypeChanged(DataType dataType);
+
+protected slots:
+ void enumChanged(QtProperty *) override;
+ void globalChanged(QtProperty *, const QString &, bool) override;
+ void parameterChanged(QtProperty *) override;
+ void parameterButtonClicked(QtProperty *) override;
+
+private:
+ void createProperties() override;
+ void popupMenu(const QPoint &) override;
+ void setParameterPropertyValue(QtProperty *prop, double value, double error);
+ void setGlobalParametersQuiet(const QStringList &globals);
+
+ QtProperty *m_fitType;
+ QMap<QString, QtProperty *> m_parameterMap;
+ QMap<QtProperty *, QString> m_parameterNames;
+
+private:
+ FQTemplatePresenter m_presenter;
+ bool m_emitParameterValueChange = true;
+ bool m_emitBoolChange = true;
+ bool m_emitEnumChange = true;
+ friend class FQTemplatePresenter;
+};
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
+
+#endif /*INDIRECT_FQTEMPLATEBROWSER_H_*/
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplatePresenter.cpp b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplatePresenter.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..0052218cf4e00dafead6b57a6b9fb18c1a68c7b6
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplatePresenter.cpp
@@ -0,0 +1,254 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "FQTemplatePresenter.h"
+#include "FQTemplateBrowser.h"
+#include "MantidQtWidgets/Common/EditLocalParameterDialog.h"
+#include <math.h>
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+using namespace MantidWidgets;
+
+/**
+ * Constructor
+ * @param parent :: The parent widget.
+ */
+FQTemplatePresenter::FQTemplatePresenter(FQTemplateBrowser *view)
+ : QObject(view), m_view(view) {
+ connect(m_view, SIGNAL(localParameterButtonClicked(const QString &)), this,
+ SLOT(editLocalParameter(const QString &)));
+ connect(m_view, SIGNAL(parameterValueChanged(const QString &, double)), this,
+ SLOT(viewChangedParameterValue(const QString &, double)));
+ connect(m_view, SIGNAL(dataTypeChanged(DataType)), this,
+ SLOT(handleDataTypeChanged(DataType)));
+}
+
+void FQTemplatePresenter::setFitType(const QString &name) {
+ m_view->clear();
+ m_model.setFitType(name);
+ if (name == "None")
+ return;
+ auto functionParameters = m_model.getParameterNames();
+ for (auto ¶meter : functionParameters) {
+ m_view->addParameter(parameter, m_model.getParameterDescription(parameter));
+ }
+
+ setErrorsEnabled(false);
+ updateView();
+ emit functionStructureChanged();
+}
+
+void FQTemplatePresenter::setNumberOfDatasets(int n) {
+ m_model.setNumberDomains(n);
+}
+
+int FQTemplatePresenter::getNumberOfDatasets() const {
+ return m_model.getNumberDomains();
+}
+
+int FQTemplatePresenter::getCurrentDataset() {
+ return m_model.currentDomainIndex();
+}
+
+void FQTemplatePresenter::setFunction(const QString &funStr) {
+ m_view->clear();
+ m_model.setFunctionString(funStr);
+
+ if (m_model.getFitType() == "None")
+ return;
+ auto functionParameters = m_model.getParameterNames();
+ for (auto ¶meter : functionParameters) {
+ m_view->addParameter(parameter, m_model.getParameterDescription(parameter));
+ }
+ m_view->setEnumValue(m_model.getEnumIndex());
+ setErrorsEnabled(false);
+ updateView();
+ emit functionStructureChanged();
+}
+
+IFunction_sptr FQTemplatePresenter::getGlobalFunction() const {
+ return m_model.getFitFunction();
+}
+
+IFunction_sptr FQTemplatePresenter::getFunction() const {
+ return m_model.getCurrentFunction();
+}
+
+QStringList FQTemplatePresenter::getGlobalParameters() const {
+ return m_model.getGlobalParameters();
+}
+
+QStringList FQTemplatePresenter::getLocalParameters() const {
+ return m_model.getLocalParameters();
+}
+
+void FQTemplatePresenter::setGlobalParameters(const QStringList &globals) {
+ m_model.setGlobalParameters(globals);
+ m_view->setGlobalParametersQuiet(globals);
+}
+
+void FQTemplatePresenter::setGlobal(const QString &parName, bool on) {
+ m_model.setGlobal(parName, on);
+ m_view->setGlobalParametersQuiet(m_model.getGlobalParameters());
+}
+
+void FQTemplatePresenter::updateMultiDatasetParameters(const IFunction &fun) {
+ m_model.updateMultiDatasetParameters(fun);
+ updateView();
+}
+
+void FQTemplatePresenter::updateParameters(const IFunction &fun) {
+ m_model.updateParameters(fun);
+ updateView();
+}
+
+void FQTemplatePresenter::setCurrentDataset(int i) {
+ m_model.setCurrentDomainIndex(i);
+ updateView();
+}
+
+void FQTemplatePresenter::setDatasetNames(const QStringList &names) {
+ m_model.setDatasetNames(names);
+}
+
+void FQTemplatePresenter::setErrorsEnabled(bool enabled) {
+ m_view->setErrorsEnabled(enabled);
+}
+
+void FQTemplatePresenter::updateParameterEstimationData(
+ DataForParameterEstimationCollection &&data) {
+ m_model.updateParameterEstimationData(std::move(data));
+}
+
+QStringList FQTemplatePresenter::getDatasetNames() const {
+ return m_model.getDatasetNames();
+}
+
+double FQTemplatePresenter::getLocalParameterValue(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterValue(parName, i);
+}
+
+bool FQTemplatePresenter::isLocalParameterFixed(const QString &parName,
+ int i) const {
+ return m_model.isLocalParameterFixed(parName, i);
+}
+
+QString FQTemplatePresenter::getLocalParameterTie(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterTie(parName, i);
+}
+
+QString FQTemplatePresenter::getLocalParameterConstraint(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterConstraint(parName, i);
+}
+
+void FQTemplatePresenter::setLocalParameterValue(const QString &parName, int i,
+ double value) {
+ m_model.setLocalParameterValue(parName, i, value);
+}
+
+void FQTemplatePresenter::setLocalParameterTie(const QString &parName, int i,
+ const QString &tie) {
+ m_model.setLocalParameterTie(parName, i, tie);
+}
+
+void FQTemplatePresenter::updateView() {
+ if (m_model.getFitType() == "None")
+ return;
+ for (auto parameterName : m_model.getParameterNames()) {
+ m_view->setParameterValue(parameterName,
+ m_model.getParameter(parameterName),
+ m_model.getParameterError(parameterName));
+ }
+}
+
+void FQTemplatePresenter::setLocalParameterFixed(const QString &parName, int i,
+ bool fixed) {
+ m_model.setLocalParameterFixed(parName, i, fixed);
+}
+
+void FQTemplatePresenter::editLocalParameter(const QString &parName) {
+ auto const wsNames = getDatasetNames();
+ QList<double> values;
+ QList<bool> fixes;
+ QStringList ties;
+ QStringList constraints;
+ const int n = wsNames.size();
+ for (auto i = 0; i < n; ++i) {
+ const double value = getLocalParameterValue(parName, i);
+ values.push_back(value);
+ const bool fixed = isLocalParameterFixed(parName, i);
+ fixes.push_back(fixed);
+ const auto tie = getLocalParameterTie(parName, i);
+ ties.push_back(tie);
+ const auto constraint = getLocalParameterConstraint(parName, i);
+ constraints.push_back(constraint);
+ }
+
+ m_editLocalParameterDialog = new EditLocalParameterDialog(
+ m_view, parName, wsNames, values, fixes, ties, constraints);
+ connect(m_editLocalParameterDialog, SIGNAL(finished(int)), this,
+ SLOT(editLocalParameterFinish(int)));
+ m_editLocalParameterDialog->open();
+}
+
+void FQTemplatePresenter::editLocalParameterFinish(int result) {
+ if (result == QDialog::Accepted) {
+ const auto parName = m_editLocalParameterDialog->getParameterName();
+ const auto values = m_editLocalParameterDialog->getValues();
+ const auto fixes = m_editLocalParameterDialog->getFixes();
+ const auto ties = m_editLocalParameterDialog->getTies();
+ assert(values.size() == getNumberOfDatasets());
+ for (int i = 0; i < values.size(); ++i) {
+ setLocalParameterValue(parName, i, values[i]);
+ if (!ties[i].isEmpty()) {
+ setLocalParameterTie(parName, i, ties[i]);
+ } else if (fixes[i]) {
+ setLocalParameterFixed(parName, i, fixes[i]);
+ } else {
+ setLocalParameterTie(parName, i, "");
+ }
+ }
+ }
+ m_editLocalParameterDialog = nullptr;
+ updateView();
+ emit functionStructureChanged();
+}
+
+void FQTemplatePresenter::viewChangedParameterValue(const QString &parName,
+ double value) {
+ if (parName.isEmpty())
+ return;
+ if (m_model.isGlobal(parName)) {
+ const auto n = getNumberOfDatasets();
+ for (int i = 0; i < n; ++i) {
+ setLocalParameterValue(parName, i, value);
+ }
+ } else {
+ const auto i = m_model.currentDomainIndex();
+ const auto oldValue = m_model.getLocalParameterValue(parName, i);
+ if (fabs(value - oldValue) > 1e-6) {
+ setErrorsEnabled(false);
+ }
+ setLocalParameterValue(parName, i, value);
+ }
+ emit functionStructureChanged();
+}
+
+void FQTemplatePresenter::handleDataTypeChanged(DataType dataType) {
+ m_model.setDataType(dataType);
+ m_view->setDataType(m_model.getFunctionList());
+ setFitType("None");
+}
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
\ No newline at end of file
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplatePresenter.h b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplatePresenter.h
new file mode 100644
index 0000000000000000000000000000000000000000..250396c431e6d053164c6419fc20ca453e2fb793
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/FQTemplatePresenter.h
@@ -0,0 +1,86 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef INDIRECT_FQTEMPLATEPRESENTER_H_
+#define INDIRECT_FQTEMPLATEPRESENTER_H_
+
+#include "DllConfig.h"
+#include "FQFunctionModel.h"
+#include "IFQFitObserver.h"
+#include "ParameterEstimation.h"
+
+#include <QMap>
+#include <QWidget>
+
+class QtProperty;
+
+namespace MantidQt {
+namespace MantidWidgets {
+class EditLocalParameterDialog;
+}
+namespace CustomInterfaces {
+namespace IDA {
+
+class FQTemplateBrowser;
+
+/**
+ * Class FunctionTemplateBrowser implements QtPropertyBrowser to display
+ * and set properties that can be used to generate a fit function.
+ *
+ */
+class MANTIDQT_INDIRECT_DLL FQTemplatePresenter : public QObject {
+ Q_OBJECT
+public:
+ explicit FQTemplatePresenter(FQTemplateBrowser *view);
+ void setFitType(const QString &name);
+
+ void setNumberOfDatasets(int);
+ int getNumberOfDatasets() const;
+ int getCurrentDataset();
+ void setFunction(const QString &funStr);
+ IFunction_sptr getGlobalFunction() const;
+ IFunction_sptr getFunction() const;
+ QStringList getGlobalParameters() const;
+ QStringList getLocalParameters() const;
+ void setGlobalParameters(const QStringList &globals);
+ void setGlobal(const QString &parName, bool on);
+ void updateMultiDatasetParameters(const IFunction &fun);
+ void updateParameters(const IFunction &fun);
+ void setCurrentDataset(int i);
+ void setDatasetNames(const QStringList &names);
+ void setErrorsEnabled(bool enabled);
+ void
+ updateParameterEstimationData(DataForParameterEstimationCollection &&data);
+
+signals:
+ void functionStructureChanged();
+
+private slots:
+ void handleDataTypeChanged(DataType);
+ void editLocalParameter(const QString &parName);
+ void editLocalParameterFinish(int result);
+ void viewChangedParameterValue(const QString &parName, double value);
+
+private:
+ QStringList getDatasetNames() const;
+ double getLocalParameterValue(const QString &parName, int i) const;
+ bool isLocalParameterFixed(const QString &parName, int i) const;
+ QString getLocalParameterTie(const QString &parName, int i) const;
+ QString getLocalParameterConstraint(const QString &parName, int i) const;
+ void setLocalParameterValue(const QString &parName, int i, double value);
+ void setLocalParameterFixed(const QString &parName, int i, bool fixed);
+ void setLocalParameterTie(const QString &parName, int i, const QString &tie);
+ void updateView();
+ FQTemplateBrowser *m_view;
+ FQFunctionModel m_model;
+ EditLocalParameterDialog *m_editLocalParameterDialog;
+};
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
+
+#endif /*INDIRECT_FQTEMPLATEPRESENTER_H_*/
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/IqtFunctionModel.cpp b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/IqtFunctionModel.cpp
index df9e14cd09e8ad58df58f42cf95ade878ca7d612..5b2b04a6b437fee9a4a5d48140440fba576c40a5 100644
--- a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/IqtFunctionModel.cpp
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/IqtFunctionModel.cpp
@@ -133,7 +133,7 @@ void IqtFunctionModel::addFunction(const QString &prefix,
setBackground(QString::fromStdString(name));
newPrefix = *getBackgroundPrefix();
} else {
- throw std::runtime_error("Cannot add funtion " + name);
+ throw std::runtime_error("Cannot add function " + name);
}
auto newFun = getFunctionWithPrefix(newPrefix, getSingleFunction(0));
copyParametersAndErrors(*fun, *newFun);
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDFunctionModel.cpp b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDFunctionModel.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..7ab749f70091b267f554244aa06c722670814484
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDFunctionModel.cpp
@@ -0,0 +1,525 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "MSDFunctionModel.h"
+#include "MantidAPI/FunctionFactory.h"
+#include "MantidAPI/IFunction.h"
+#include "MantidAPI/ITableWorkspace.h"
+#include "MantidQtWidgets/Common/FunctionBrowser/FunctionBrowserUtils.h"
+#include <unordered_map>
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+using namespace MantidWidgets;
+using namespace Mantid::API;
+
+namespace {
+std::unordered_map<MSDFunctionModel::ParamID, QString> g_paramName{
+ {MSDFunctionModel::ParamID::GAUSSIAN_HEIGHT, "Height"},
+ {MSDFunctionModel::ParamID::GAUSSIAN_MSD, "Msd"},
+ {MSDFunctionModel::ParamID::PETERS_HEIGHT, "Height"},
+ {MSDFunctionModel::ParamID::PETERS_MSD, "Msd"},
+ {MSDFunctionModel::ParamID::PETERS_BETA, "Beta"},
+ {MSDFunctionModel::ParamID::YI_HEIGHT, "Height"},
+ {MSDFunctionModel::ParamID::YI_MSD, "Msd"},
+ {MSDFunctionModel::ParamID::YI_SIGMA, "Sigma"}};
+
+const std::string Gauss = "MsdGauss";
+const std::string Peters = "MsdPeters";
+const std::string Yi = "MsdYi";
+} // namespace
+
+void MSDFunctionModel::clearData() {
+ m_fitType.clear();
+ m_model.clear();
+}
+
+void MSDFunctionModel::setFunction(IFunction_sptr fun) {
+ clearData();
+ if (!fun)
+ return;
+ if (fun->nFunctions() == 0) {
+ const auto name = fun->name();
+ if (name == Gauss || name == Peters || name == Yi) {
+ m_fitType = QString::fromStdString(name);
+ } else {
+ throw std::runtime_error("Cannot set function " + name);
+ }
+ m_model.setFunction(fun);
+ return;
+ }
+ bool isFitTypeSet = false;
+ for (size_t i = 0; i < fun->nFunctions(); ++i) {
+ const auto f = fun->getFunction(i);
+ const auto name = f->name();
+ if (name == Gauss || name == Peters || name == Yi) {
+ if (isFitTypeSet) {
+ throw std::runtime_error("More than one function not allowed.");
+ }
+ m_fitType = QString::fromStdString(name);
+ isFitTypeSet = true;
+ } else {
+ clear();
+ throw std::runtime_error("Function is not of an allowed type.");
+ }
+ }
+ m_model.setFunction(fun);
+}
+
+IFunction_sptr MSDFunctionModel::getFitFunction() const {
+ return m_model.getFitFunction();
+}
+
+bool MSDFunctionModel::hasFunction() const { return m_model.hasFunction(); }
+
+void MSDFunctionModel::addFunction(const QString &prefix,
+ const QString &funStr) {
+ if (!prefix.isEmpty())
+ throw std::runtime_error(
+ "Function doesn't have member function with prefix " +
+ prefix.toStdString());
+ const auto fun =
+ FunctionFactory::Instance().createInitialized(funStr.toStdString());
+ const auto name = fun->name();
+ QString newPrefix;
+ if (name == Gauss || name == Peters || name == Yi) {
+ setFitType(QString::fromStdString(name));
+ newPrefix = *getFitTypePrefix();
+ } else {
+ throw std::runtime_error("Cannot add function " + name);
+ }
+ auto newFun = getFunctionWithPrefix(newPrefix, getSingleFunction(0));
+ copyParametersAndErrors(*fun, *newFun);
+ if (getNumberLocalFunctions() > 1) {
+ copyParametersAndErrorsToAllLocalFunctions(*getSingleFunction(0));
+ }
+}
+
+void MSDFunctionModel::removeFunction(const QString &prefix) {
+ if (prefix.isEmpty()) {
+ clear();
+ return;
+ }
+ auto prefix1 = getFitTypePrefix();
+ if (prefix1 && *prefix1 == prefix) {
+ removeFitType();
+ return;
+ }
+ throw std::runtime_error(
+ "Function doesn't have member function with prefix " +
+ prefix.toStdString());
+}
+
+void MSDFunctionModel::setFitType(const QString &name) {
+ const auto oldValues = getCurrentValues();
+ m_fitType = name;
+ m_model.setFunctionString(buildFunctionString());
+ m_model.setGlobalParameters(makeGlobalList());
+ setCurrentValues(oldValues);
+}
+
+void MSDFunctionModel::removeFitType() {
+ const auto oldValues = getCurrentValues();
+ m_fitType.clear();
+ m_model.setFunctionString(buildFunctionString());
+ m_model.setGlobalParameters(makeGlobalList());
+ setCurrentValues(oldValues);
+}
+
+bool MSDFunctionModel::hasGaussianType() const {
+ return m_fitType == QString::fromStdString(Gauss);
+}
+
+bool MSDFunctionModel::hasPetersType() const {
+ return m_fitType == QString::fromStdString(Peters);
+}
+
+bool MSDFunctionModel::hasYiType() const {
+ return m_fitType == QString::fromStdString(Yi);
+}
+
+void MSDFunctionModel::updateParameterEstimationData(
+ DataForParameterEstimationCollection &&data) {
+ m_estimationData = std::move(data);
+}
+
+void MSDFunctionModel::setNumberDomains(int n) { m_model.setNumberDomains(n); }
+
+int MSDFunctionModel::getNumberDomains() const {
+ return m_model.getNumberDomains();
+}
+
+void MSDFunctionModel::setParameter(const QString ¶mName, double value) {
+ m_model.setParameterError(paramName, value);
+}
+
+void MSDFunctionModel::setParameterError(const QString ¶mName,
+ double value) {
+ m_model.setParameterError(paramName, value);
+}
+
+double MSDFunctionModel::getParameter(const QString ¶mName) const {
+ return m_model.getParameter(paramName);
+}
+
+double MSDFunctionModel::getParameterError(const QString ¶mName) const {
+ return m_model.getParameterError(paramName);
+}
+
+QString
+MSDFunctionModel::getParameterDescription(const QString ¶mName) const {
+ return m_model.getParameterDescription(paramName);
+}
+
+QStringList MSDFunctionModel::getParameterNames() const {
+ return m_model.getParameterNames();
+}
+
+IFunction_sptr MSDFunctionModel::getSingleFunction(int index) const {
+ return m_model.getSingleFunction(index);
+}
+
+IFunction_sptr MSDFunctionModel::getCurrentFunction() const {
+ return m_model.getCurrentFunction();
+}
+
+QStringList MSDFunctionModel::getGlobalParameters() const {
+ return m_model.getGlobalParameters();
+}
+
+QStringList MSDFunctionModel::getLocalParameters() const {
+ return m_model.getLocalParameters();
+}
+
+void MSDFunctionModel::setGlobalParameters(const QStringList &globals) {
+ m_globals.clear();
+ for (const auto &name : globals) {
+ addGlobal(name);
+ }
+ auto newGlobals = makeGlobalList();
+ m_model.setGlobalParameters(newGlobals);
+}
+
+bool MSDFunctionModel::isGlobal(const QString &parName) const {
+ return m_model.isGlobal(parName);
+}
+
+void MSDFunctionModel::setGlobal(const QString &parName, bool on) {
+ if (parName.isEmpty())
+ return;
+ if (on)
+ addGlobal(parName);
+ else
+ removeGlobal(parName);
+ auto globals = makeGlobalList();
+ m_model.setGlobalParameters(globals);
+}
+
+void MSDFunctionModel::addGlobal(const QString &parName) {
+ const auto pid = getParameterId(parName);
+ if (pid && !m_globals.contains(*pid)) {
+ m_globals.push_back(*pid);
+ }
+}
+
+void MSDFunctionModel::removeGlobal(const QString &parName) {
+ const auto pid = getParameterId(parName);
+ if (pid && m_globals.contains(*pid)) {
+ m_globals.removeOne(*pid);
+ }
+}
+
+QStringList MSDFunctionModel::makeGlobalList() const {
+ QStringList globals;
+ for (const auto &id : m_globals) {
+ const auto name = getParameterName(id);
+ if (name)
+ globals << *name;
+ }
+ return globals;
+}
+
+void MSDFunctionModel::updateMultiDatasetParameters(const IFunction &fun) {
+ m_model.updateMultiDatasetParameters(fun);
+}
+
+void MSDFunctionModel::updateMultiDatasetParameters(
+ const ITableWorkspace ¶mTable) {
+ const auto nRows = paramTable.rowCount();
+ if (nRows == 0)
+ return;
+
+ const auto globalParameterNames = getGlobalParameters();
+ for (auto &&name : globalParameterNames) {
+ const auto valueColumn = paramTable.getColumn(name.toStdString());
+ const auto errorColumn =
+ paramTable.getColumn((name + "_Err").toStdString());
+ m_model.setParameter(name, valueColumn->toDouble(0));
+ m_model.setParameterError(name, errorColumn->toDouble(0));
+ }
+
+ const auto localParameterNames = getLocalParameters();
+ for (auto &&name : localParameterNames) {
+ const auto valueColumn = paramTable.getColumn(name.toStdString());
+ const auto errorColumn =
+ paramTable.getColumn((name + "_Err").toStdString());
+ if (nRows > 1) {
+ for (size_t i = 0; i < nRows; ++i) {
+ m_model.setLocalParameterValue(name, static_cast<int>(i),
+ valueColumn->toDouble(i),
+ errorColumn->toDouble(i));
+ }
+ } else {
+ const auto i = m_model.currentDomainIndex();
+ m_model.setLocalParameterValue(name, static_cast<int>(i),
+ valueColumn->toDouble(0),
+ errorColumn->toDouble(0));
+ }
+ }
+}
+
+void MSDFunctionModel::updateParameters(const IFunction &fun) {
+ m_model.updateParameters(fun);
+}
+
+void MSDFunctionModel::setCurrentDomainIndex(int i) {
+ m_model.setCurrentDomainIndex(i);
+}
+
+int MSDFunctionModel::currentDomainIndex() const {
+ return m_model.currentDomainIndex();
+}
+
+void MSDFunctionModel::changeTie(const QString ¶mName, const QString &tie) {
+ m_model.changeTie(paramName, tie);
+}
+
+void MSDFunctionModel::addConstraint(const QString &functionIndex,
+ const QString &constraint) {
+ m_model.addConstraint(functionIndex, constraint);
+}
+
+void MSDFunctionModel::removeConstraint(const QString ¶mName) {
+ m_model.removeConstraint(paramName);
+}
+
+void MSDFunctionModel::setDatasetNames(const QStringList &names) {
+ m_model.setDatasetNames(names);
+}
+
+QStringList MSDFunctionModel::getDatasetNames() const {
+ return m_model.getDatasetNames();
+}
+
+double MSDFunctionModel::getLocalParameterValue(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterValue(parName, i);
+}
+
+bool MSDFunctionModel::isLocalParameterFixed(const QString &parName,
+ int i) const {
+ return m_model.isLocalParameterFixed(parName, i);
+}
+
+QString MSDFunctionModel::getLocalParameterTie(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterTie(parName, i);
+}
+
+QString MSDFunctionModel::getLocalParameterConstraint(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterConstraint(parName, i);
+}
+
+void MSDFunctionModel::setLocalParameterValue(const QString &parName, int i,
+ double value) {
+ m_model.setLocalParameterValue(parName, i, value);
+}
+
+void MSDFunctionModel::setLocalParameterValue(const QString &parName, int i,
+ double value, double error) {
+ m_model.setLocalParameterValue(parName, i, value, error);
+}
+
+void MSDFunctionModel::setLocalParameterTie(const QString &parName, int i,
+ const QString &tie) {
+ m_model.setLocalParameterTie(parName, i, tie);
+}
+
+void MSDFunctionModel::setLocalParameterConstraint(const QString &parName,
+ int i,
+ const QString &constraint) {
+ m_model.setLocalParameterConstraint(parName, i, constraint);
+}
+
+void MSDFunctionModel::setLocalParameterFixed(const QString &parName, int i,
+ bool fixed) {
+ m_model.setLocalParameterFixed(parName, i, fixed);
+}
+
+void MSDFunctionModel::setParameter(ParamID name, double value) {
+ const auto prefix = getPrefix(name);
+ if (prefix) {
+ m_model.setParameter(*prefix + g_paramName.at(name), value);
+ }
+}
+
+boost::optional<double> MSDFunctionModel::getParameter(ParamID name) const {
+ const auto paramName = getParameterName(name);
+ return paramName ? m_model.getParameter(*paramName)
+ : boost::optional<double>();
+}
+
+boost::optional<double>
+MSDFunctionModel::getParameterError(ParamID name) const {
+ const auto paramName = getParameterName(name);
+ return paramName ? m_model.getParameterError(*paramName)
+ : boost::optional<double>();
+}
+
+boost::optional<QString>
+MSDFunctionModel::getParameterName(ParamID name) const {
+ const auto prefix = getPrefix(name);
+ return prefix ? *prefix + g_paramName.at(name) : boost::optional<QString>();
+}
+
+boost::optional<QString>
+MSDFunctionModel::getParameterDescription(ParamID name) const {
+ const auto paramName = getParameterName(name);
+ return paramName ? m_model.getParameterDescription(*paramName)
+ : boost::optional<QString>();
+}
+
+boost::optional<QString> MSDFunctionModel::getPrefix(ParamID) const {
+ return getFitTypePrefix();
+}
+
+QMap<MSDFunctionModel::ParamID, double>
+MSDFunctionModel::getCurrentValues() const {
+ QMap<ParamID, double> values;
+ auto store = [&values, this](ParamID name) {
+ values[name] = *getParameter(name);
+ };
+ applyParameterFunction(store);
+ return values;
+}
+
+QMap<MSDFunctionModel::ParamID, double>
+MSDFunctionModel::getCurrentErrors() const {
+ QMap<ParamID, double> errors;
+ auto store = [&errors, this](ParamID name) {
+ errors[name] = *getParameterError(name);
+ };
+ applyParameterFunction(store);
+ return errors;
+}
+
+QMap<int, QString> MSDFunctionModel::getParameterNameMap() const {
+ QMap<int, QString> out;
+ auto addToMap = [&out, this](ParamID name) {
+ out[static_cast<int>(name)] = *getParameterName(name);
+ };
+ applyParameterFunction(addToMap);
+ return out;
+}
+
+QMap<int, std::string> MSDFunctionModel::getParameterDescriptionMap() const {
+ QMap<int, std::string> out;
+ auto gaussian = FunctionFactory::Instance().createInitialized(
+ buildGaussianFunctionString());
+ out[static_cast<int>(ParamID::GAUSSIAN_HEIGHT)] =
+ gaussian->parameterDescription(0);
+ out[static_cast<int>(ParamID::GAUSSIAN_MSD)] =
+ gaussian->parameterDescription(1);
+ auto peters = FunctionFactory::Instance().createInitialized(
+ buildPetersFunctionString());
+ out[static_cast<int>(ParamID::PETERS_HEIGHT)] =
+ peters->parameterDescription(0);
+ out[static_cast<int>(ParamID::PETERS_MSD)] = peters->parameterDescription(1);
+ out[static_cast<int>(ParamID::PETERS_BETA)] = peters->parameterDescription(2);
+ auto yi =
+ FunctionFactory::Instance().createInitialized(buildYiFunctionString());
+ out[static_cast<int>(ParamID::YI_HEIGHT)] = yi->parameterDescription(0);
+ out[static_cast<int>(ParamID::YI_MSD)] = yi->parameterDescription(1);
+ out[static_cast<int>(ParamID::YI_SIGMA)] = yi->parameterDescription(2);
+ return out;
+}
+
+void MSDFunctionModel::setCurrentValues(const QMap<ParamID, double> &values) {
+ for (const auto &name : values.keys()) {
+ setParameter(name, values[name]);
+ }
+}
+
+void MSDFunctionModel::applyParameterFunction(
+ std::function<void(ParamID)> paramFun) const {
+ if (m_fitType == QString::fromStdString(Gauss)) {
+ paramFun(ParamID::GAUSSIAN_HEIGHT);
+ paramFun(ParamID::GAUSSIAN_MSD);
+ }
+ if (m_fitType == QString::fromStdString(Peters)) {
+ paramFun(ParamID::PETERS_HEIGHT);
+ paramFun(ParamID::PETERS_MSD);
+ paramFun(ParamID::PETERS_BETA);
+ }
+ if (m_fitType == QString::fromStdString(Yi)) {
+ paramFun(ParamID::YI_HEIGHT);
+ paramFun(ParamID::YI_MSD);
+ paramFun(ParamID::YI_SIGMA);
+ }
+}
+
+boost::optional<MSDFunctionModel::ParamID>
+MSDFunctionModel::getParameterId(const QString &parName) {
+ boost::optional<ParamID> result;
+ auto getter = [&result, parName, this](ParamID pid) {
+ if (parName == *getParameterName(pid))
+ result = pid;
+ };
+ applyParameterFunction(getter);
+ return result;
+}
+
+std::string MSDFunctionModel::buildGaussianFunctionString() const {
+ return "name=MsdGauss,Height=1,Msd=0.05,constraints=(Height>0)";
+}
+
+std::string MSDFunctionModel::buildPetersFunctionString() const {
+ return "name=MsdPeters,Height=1,Msd=0.05,Beta=1,constraints=(Height>0)";
+}
+
+std::string MSDFunctionModel::buildYiFunctionString() const {
+ return "name=MsdYi,Height=1,Msd=0.05,Sigma=1,constraints=(Height>0)";
+}
+
+QString MSDFunctionModel::buildFunctionString() const {
+ QStringList functions;
+ if (m_fitType == QString::fromStdString(Gauss)) {
+ functions << QString::fromStdString(buildGaussianFunctionString());
+ }
+ if (m_fitType == QString::fromStdString(Peters)) {
+ functions << QString::fromStdString(buildPetersFunctionString());
+ }
+ if (m_fitType == QString::fromStdString(Yi)) {
+ functions << QString::fromStdString(buildYiFunctionString());
+ }
+ return functions.join(";");
+}
+
+boost::optional<QString> MSDFunctionModel::getFitTypePrefix() const {
+ if (m_fitType.isEmpty())
+ return boost::optional<QString>();
+ return QString();
+}
+
+// Backgrounds are not needed for MsD fit.
+QString MSDFunctionModel::setBackgroundA0(double) { return ""; }
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDFunctionModel.h b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDFunctionModel.h
new file mode 100644
index 0000000000000000000000000000000000000000..076ee4ef56b696e29eff74203da9bb7ad067f2d7
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDFunctionModel.h
@@ -0,0 +1,134 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef MANTIDQT_INDIRECT_MSDFUNCTIONMODEL_H_
+#define MANTIDQT_INDIRECT_MSDFUNCTIONMODEL_H_
+
+#include "DllConfig.h"
+#include "IndexTypes.h"
+#include "MantidAPI/IFunction_fwd.h"
+#include "MantidAPI/ITableWorkspace_fwd.h"
+#include "MantidQtWidgets/Common/FunctionModel.h"
+#include "ParameterEstimation.h"
+
+#include <QMap>
+#include <boost/optional.hpp>
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+using namespace Mantid::API;
+using namespace MantidWidgets;
+
+class MANTIDQT_INDIRECT_DLL MSDFunctionModel : public IFunctionModel {
+public:
+ MSDFunctionModel() = default;
+ void setFunction(IFunction_sptr fun) override;
+ IFunction_sptr getFitFunction() const override;
+ bool hasFunction() const override;
+ void addFunction(const QString &prefix, const QString &funStr) override;
+ void removeFunction(const QString &prefix) override;
+ void setParameter(const QString ¶mName, double value) override;
+ void setParameterError(const QString ¶mName, double value) override;
+ double getParameter(const QString ¶mName) const override;
+ double getParameterError(const QString ¶mName) const override;
+ QString getParameterDescription(const QString ¶mName) const override;
+ QStringList getParameterNames() const override;
+ IFunction_sptr getSingleFunction(int index) const override;
+ IFunction_sptr getCurrentFunction() const override;
+ void setNumberDomains(int) override;
+ void setDatasetNames(const QStringList &names) override;
+ QStringList getDatasetNames() const override;
+ int getNumberDomains() const override;
+ void setCurrentDomainIndex(int i) override;
+ int currentDomainIndex() const override;
+ void changeTie(const QString ¶mName, const QString &tie) override;
+ void addConstraint(const QString &functionIndex,
+ const QString &constraint) override;
+ void removeConstraint(const QString ¶mName) override;
+ QStringList getGlobalParameters() const override;
+ void setGlobalParameters(const QStringList &globals) override;
+ bool isGlobal(const QString &parName) const override;
+ void setGlobal(const QString &parName, bool on);
+ QStringList getLocalParameters() const override;
+ void updateMultiDatasetParameters(const IFunction &fun) override;
+ void updateParameters(const IFunction &fun) override;
+
+ double getLocalParameterValue(const QString &parName, int i) const override;
+ bool isLocalParameterFixed(const QString &parName, int i) const override;
+ QString getLocalParameterTie(const QString &parName, int i) const override;
+ QString getLocalParameterConstraint(const QString &parName,
+ int i) const override;
+ void setLocalParameterValue(const QString &parName, int i,
+ double value) override;
+ void setLocalParameterValue(const QString &parName, int i, double value,
+ double error) override;
+ void setLocalParameterFixed(const QString &parName, int i,
+ bool fixed) override;
+ void setLocalParameterTie(const QString &parName, int i,
+ const QString &tie) override;
+ void setLocalParameterConstraint(const QString &parName, int i,
+ const QString &constraint) override;
+ QString setBackgroundA0(double value) override;
+
+ void updateMultiDatasetParameters(const ITableWorkspace ¶mTable);
+ void setFitType(const QString &name);
+ void removeFitType();
+ bool hasGaussianType() const;
+ bool hasPetersType() const;
+ bool hasYiType() const;
+ void
+ updateParameterEstimationData(DataForParameterEstimationCollection &&data);
+
+ enum class ParamID {
+ GAUSSIAN_HEIGHT,
+ GAUSSIAN_MSD,
+ PETERS_HEIGHT,
+ PETERS_MSD,
+ PETERS_BETA,
+ YI_HEIGHT,
+ YI_MSD,
+ YI_SIGMA
+ };
+ QMap<ParamID, double> getCurrentValues() const;
+ QMap<ParamID, double> getCurrentErrors() const;
+ QMap<int, QString> getParameterNameMap() const;
+ QMap<int, std::string> getParameterDescriptionMap() const;
+
+private:
+ void clearData();
+ QString buildFunctionString() const;
+ boost::optional<QString> getFitTypePrefix() const;
+ void setParameter(ParamID name, double value);
+ boost::optional<double> getParameter(ParamID name) const;
+ boost::optional<double> getParameterError(ParamID name) const;
+ boost::optional<QString> getParameterName(ParamID name) const;
+ boost::optional<QString> getParameterDescription(ParamID name) const;
+ boost::optional<QString> getPrefix(ParamID name) const;
+ void setCurrentValues(const QMap<ParamID, double> &);
+ void applyParameterFunction(std::function<void(ParamID)> paramFun) const;
+ boost::optional<ParamID> getParameterId(const QString &parName);
+ std::string buildGaussianFunctionString() const;
+ std::string buildPetersFunctionString() const;
+ std::string buildYiFunctionString() const;
+ void addGlobal(const QString &parName);
+ void removeGlobal(const QString &parName);
+ QStringList makeGlobalList() const;
+
+ FunctionModel m_model;
+ QString m_fitType;
+ DataForParameterEstimationCollection m_estimationData;
+ QList<ParamID> m_globals;
+ std::string m_resolutionName;
+ TableDatasetIndex m_resolutionIndex;
+};
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
+
+#endif /* MANTIDQT_INDIRECT_MSDFUNCTIONMODEL_H_ */
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplateBrowser.cpp b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplateBrowser.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..731b59920d685d0a76b2c8d379a54b99bab910a4
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplateBrowser.cpp
@@ -0,0 +1,347 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "MSDTemplateBrowser.h"
+
+#include "MantidAPI/CostFunctionFactory.h"
+#include "MantidAPI/FuncMinimizerFactory.h"
+#include "MantidAPI/IAlgorithm.h"
+#include "MantidAPI/IFuncMinimizer.h"
+#include "MantidAPI/ITableWorkspace.h"
+#include "MantidAPI/IWorkspaceProperty.h"
+#include "MantidKernel/PropertyWithValue.h"
+
+#include "MantidQtWidgets/Common/FunctionBrowser/FunctionBrowserUtils.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/ButtonEditorFactory.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/CompositeEditorFactory.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/DoubleEditorFactory.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/qteditorfactory.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/qtpropertymanager.h"
+#include "MantidQtWidgets/Common/QtPropertyBrowser/qttreepropertybrowser.h"
+
+#include <QMessageBox>
+#include <QSettings>
+#include <QVBoxLayout>
+
+#include <limits>
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+/**
+ * Constructor
+ * @param parent :: The parent widget.
+ */
+MSDTemplateBrowser::MSDTemplateBrowser(QWidget *parent)
+ : FunctionTemplateBrowser(parent), m_presenter(this) {
+ connect(&m_presenter, SIGNAL(functionStructureChanged()), this,
+ SIGNAL(functionStructureChanged()));
+}
+
+void MSDTemplateBrowser::createProperties() {
+ m_parameterManager->blockSignals(true);
+ m_boolManager->blockSignals(true);
+ m_enumManager->blockSignals(true);
+
+ m_gaussianHeight = m_parameterManager->addProperty("Height");
+ m_parameterManager->setDecimals(m_gaussianHeight, 6);
+ m_gaussianMsd = m_parameterManager->addProperty("Msd");
+ m_parameterManager->setDecimals(m_gaussianMsd, 6);
+ m_petersHeight = m_parameterManager->addProperty("Height");
+ m_parameterManager->setDecimals(m_petersHeight, 6);
+ m_petersMsd = m_parameterManager->addProperty("Msd");
+ m_parameterManager->setDecimals(m_petersMsd, 6);
+ m_petersBeta = m_parameterManager->addProperty("Beta");
+ m_parameterManager->setDecimals(m_petersBeta, 6);
+ m_yiHeight = m_parameterManager->addProperty("Height");
+ m_parameterManager->setDecimals(m_yiHeight, 6);
+ m_yiMsd = m_parameterManager->addProperty("Msd");
+ m_parameterManager->setDecimals(m_yiMsd, 6);
+ m_yiSigma = m_parameterManager->addProperty("Sigma");
+ m_parameterManager->setDecimals(m_yiSigma, 6);
+
+ m_parameterMap[m_gaussianHeight] = 0;
+ m_parameterMap[m_gaussianMsd] = 1;
+ m_parameterMap[m_petersHeight] = 2;
+ m_parameterMap[m_petersMsd] = 3;
+ m_parameterMap[m_petersBeta] = 4;
+ m_parameterMap[m_yiHeight] = 5;
+ m_parameterMap[m_yiMsd] = 6;
+ m_parameterMap[m_yiSigma] = 7;
+
+ m_presenter.setViewParameterDescriptions();
+
+ m_parameterManager->setDescription(m_gaussianHeight,
+ m_parameterDescriptions[m_gaussianHeight]);
+ m_parameterManager->setDescription(m_gaussianMsd,
+ m_parameterDescriptions[m_gaussianMsd]);
+ m_parameterManager->setDescription(m_petersHeight,
+ m_parameterDescriptions[m_petersHeight]);
+ m_parameterManager->setDescription(m_petersMsd,
+ m_parameterDescriptions[m_petersMsd]);
+ m_parameterManager->setDescription(m_petersBeta,
+ m_parameterDescriptions[m_petersBeta]);
+ m_parameterManager->setDescription(m_yiHeight,
+ m_parameterDescriptions[m_yiHeight]);
+ m_parameterManager->setDescription(m_yiMsd, m_parameterDescriptions[m_yiMsd]);
+ m_parameterManager->setDescription(m_yiSigma,
+ m_parameterDescriptions[m_yiSigma]);
+
+ m_fitType = m_enumManager->addProperty("Fit Type");
+ QStringList fitType;
+ fitType << "None"
+ << "Gaussian"
+ << "Peters"
+ << "Yi";
+ m_enumManager->setEnumNames(m_fitType, fitType);
+ m_browser->addProperty(m_fitType);
+
+ m_parameterManager->blockSignals(false);
+ m_enumManager->blockSignals(false);
+ m_boolManager->blockSignals(false);
+}
+
+void MSDTemplateBrowser::addGaussian() {
+ m_fitType->addSubProperty(m_gaussianHeight);
+ m_fitType->addSubProperty(m_gaussianMsd);
+ ScopedFalse _false(m_emitEnumChange);
+ m_enumManager->setValue(m_fitType, 1);
+}
+
+void MSDTemplateBrowser::removeGaussian() {
+ m_fitType->removeSubProperty(m_gaussianHeight);
+ m_fitType->removeSubProperty(m_gaussianMsd);
+ ScopedFalse _false(m_emitEnumChange);
+ m_enumManager->setValue(m_fitType, 0);
+}
+
+void MSDTemplateBrowser::addPeters() {
+ m_fitType->addSubProperty(m_petersHeight);
+ m_fitType->addSubProperty(m_petersMsd);
+ m_fitType->addSubProperty(m_petersBeta);
+ ScopedFalse _false(m_emitEnumChange);
+ m_enumManager->setValue(m_fitType, 2);
+}
+
+void MSDTemplateBrowser::removePeters() {
+ m_fitType->removeSubProperty(m_petersHeight);
+ m_fitType->removeSubProperty(m_petersMsd);
+ m_fitType->removeSubProperty(m_petersBeta);
+ ScopedFalse _false(m_emitEnumChange);
+ m_enumManager->setValue(m_fitType, 0);
+}
+
+void MSDTemplateBrowser::addYi() {
+ m_fitType->addSubProperty(m_yiHeight);
+ m_fitType->addSubProperty(m_yiMsd);
+ m_fitType->addSubProperty(m_yiSigma);
+ ScopedFalse _false(m_emitEnumChange);
+ m_enumManager->setValue(m_fitType, 3);
+}
+
+void MSDTemplateBrowser::removeYi() {
+ m_fitType->removeSubProperty(m_yiHeight);
+ m_fitType->removeSubProperty(m_yiMsd);
+ m_fitType->removeSubProperty(m_yiSigma);
+ ScopedFalse _false(m_emitEnumChange);
+ m_enumManager->setValue(m_fitType, 0);
+}
+
+int MSDTemplateBrowser::getCurrentDataset() {
+ return m_presenter.getCurrentDataset();
+}
+
+void MSDTemplateBrowser::setGaussianHeight(double value, double error) {
+ setParameterPropertyValue(m_gaussianHeight, value, error);
+}
+
+void MSDTemplateBrowser::setGaussianMsd(double value, double error) {
+ setParameterPropertyValue(m_gaussianMsd, value, error);
+}
+
+void MSDTemplateBrowser::setPetersHeight(double value, double error) {
+ setParameterPropertyValue(m_petersHeight, value, error);
+}
+
+void MSDTemplateBrowser::setPetersMsd(double value, double error) {
+ setParameterPropertyValue(m_petersMsd, value, error);
+}
+
+void MSDTemplateBrowser::setPetersBeta(double value, double error) {
+ setParameterPropertyValue(m_petersBeta, value, error);
+}
+
+void MSDTemplateBrowser::setYiHeight(double value, double error) {
+ setParameterPropertyValue(m_yiHeight, value, error);
+}
+
+void MSDTemplateBrowser::setYiMsd(double value, double error) {
+ setParameterPropertyValue(m_yiMsd, value, error);
+}
+
+void MSDTemplateBrowser::setYiSigma(double value, double error) {
+ setParameterPropertyValue(m_yiSigma, value, error);
+}
+
+void MSDTemplateBrowser::setFunction(const QString &funStr) {
+ m_presenter.setFunction(funStr);
+}
+
+IFunction_sptr MSDTemplateBrowser::getGlobalFunction() const {
+ return m_presenter.getGlobalFunction();
+}
+
+IFunction_sptr MSDTemplateBrowser::getFunction() const {
+ return m_presenter.getFunction();
+}
+
+void MSDTemplateBrowser::setNumberOfDatasets(int n) {
+ m_presenter.setNumberOfDatasets(n);
+}
+
+int MSDTemplateBrowser::getNumberOfDatasets() const {
+ return m_presenter.getNumberOfDatasets();
+}
+
+void MSDTemplateBrowser::setDatasetNames(const QStringList &names) {
+ m_presenter.setDatasetNames(names);
+}
+
+QStringList MSDTemplateBrowser::getGlobalParameters() const {
+ return m_presenter.getGlobalParameters();
+}
+
+QStringList MSDTemplateBrowser::getLocalParameters() const {
+ return m_presenter.getLocalParameters();
+}
+
+void MSDTemplateBrowser::setGlobalParameters(const QStringList &globals) {
+ m_presenter.setGlobalParameters(globals);
+}
+
+void MSDTemplateBrowser::enumChanged(QtProperty *prop) {
+ if (!m_emitEnumChange)
+ return;
+ if (prop == m_fitType) {
+ auto fitType = m_enumManager->enumNames(prop)[m_enumManager->value(prop)];
+ m_presenter.setFitType(fitType);
+ }
+}
+
+// This slot needs to exist to fullfil the interface but we do not need to do
+// anything in this case.
+void MSDTemplateBrowser::globalChanged(QtProperty *, const QString &, bool) {}
+
+void MSDTemplateBrowser::parameterChanged(QtProperty *prop) {
+ auto isGlobal = m_parameterManager->isGlobal(prop);
+ m_presenter.setGlobal(m_actualParameterNames[prop], isGlobal);
+ if (m_emitParameterValueChange) {
+ emit parameterValueChanged(m_actualParameterNames[prop],
+ m_parameterManager->value(prop));
+ }
+}
+
+void MSDTemplateBrowser::parameterButtonClicked(QtProperty *prop) {
+ emit localParameterButtonClicked(m_actualParameterNames[prop]);
+}
+
+void MSDTemplateBrowser::updateMultiDatasetParameters(const IFunction &fun) {
+ m_presenter.updateMultiDatasetParameters(fun);
+}
+
+void MSDTemplateBrowser::updateMultiDatasetParameters(
+ const ITableWorkspace ¶mTable) {
+ m_presenter.updateMultiDatasetParameters(paramTable);
+}
+
+void MSDTemplateBrowser::updateParameters(const IFunction &fun) {
+ m_presenter.updateParameters(fun);
+}
+
+void MSDTemplateBrowser::setCurrentDataset(int i) {
+ m_presenter.setCurrentDataset(i);
+}
+
+void MSDTemplateBrowser::updateParameterNames(
+ const QMap<int, QString> ¶meterNames) {
+ m_actualParameterNames.clear();
+ ScopedFalse _false(m_emitParameterValueChange);
+ for (const auto &prop : m_parameterMap.keys()) {
+ const auto i = m_parameterMap[prop];
+ const auto name = parameterNames[i];
+ m_actualParameterNames[prop] = name;
+ if (!name.isEmpty()) {
+ prop->setPropertyName(name);
+ }
+ }
+}
+
+void MSDTemplateBrowser::updateParameterDescriptions(
+ const QMap<int, std::string> ¶meterDescriptions) {
+ m_parameterDescriptions.clear();
+ for (auto const &prop : m_parameterMap.keys()) {
+ const auto i = m_parameterMap[prop];
+ m_parameterDescriptions[prop] = parameterDescriptions[i];
+ }
+}
+
+void MSDTemplateBrowser::setErrorsEnabled(bool enabled) {
+ ScopedFalse _false(m_emitParameterValueChange);
+ m_parameterManager->setErrorsEnabled(enabled);
+}
+
+void MSDTemplateBrowser::clear() {
+ removeGaussian();
+ removePeters();
+ removeYi();
+}
+
+void MSDTemplateBrowser::updateParameterEstimationData(
+ DataForParameterEstimationCollection &&data) {
+ m_presenter.updateParameterEstimationData(std::move(data));
+}
+
+// This function needs to exist to fullfil the interface but does not
+// need to do anything in this case.
+void MSDTemplateBrowser::popupMenu(const QPoint &) {}
+
+void MSDTemplateBrowser::setParameterPropertyValue(QtProperty *prop,
+ double value, double error) {
+ if (prop) {
+ ScopedFalse _false(m_emitParameterValueChange);
+ m_parameterManager->setValue(prop, value);
+ m_parameterManager->setError(prop, error);
+ }
+}
+
+void MSDTemplateBrowser::setGlobalParametersQuiet(const QStringList &globals) {
+ ScopedFalse _false(m_emitParameterValueChange);
+ auto parameterProperties = m_parameterMap.keys();
+ for (const auto &prop : m_parameterMap.keys()) {
+ auto const name = m_actualParameterNames[prop];
+ if (globals.contains(name)) {
+ m_parameterManager->setGlobal(prop, true);
+ parameterProperties.removeOne(prop);
+ }
+ }
+ for (const auto &prop : parameterProperties) {
+ if (!m_actualParameterNames[prop].isEmpty()) {
+ m_parameterManager->setGlobal(prop, false);
+ }
+ }
+}
+
+void MSDTemplateBrowser::setBackgroundA0(double) {}
+void MSDTemplateBrowser::setResolution(std::string const &,
+ TableDatasetIndex const &) {}
+void MSDTemplateBrowser::setResolution(
+ const std::vector<std::pair<std::string, int>> &) {}
+void MSDTemplateBrowser::setQValues(const std::vector<double> &) {}
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplateBrowser.h b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplateBrowser.h
new file mode 100644
index 0000000000000000000000000000000000000000..dec42e9926b9ca8b410dff100247623b4d54c210
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplateBrowser.h
@@ -0,0 +1,113 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef INDIRECT_MSDTEMPLATEBROWSER_H_
+#define INDIRECT_MSDTEMPLATEBROWSER_H_
+
+#include "DllConfig.h"
+#include "FunctionTemplateBrowser.h"
+#include "MSDTemplatePresenter.h"
+
+#include <QMap>
+#include <QWidget>
+
+class QtProperty;
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+/**
+ * Class FunctionTemplateBrowser implements QtPropertyBrowser to display
+ * and set properties that can be used to generate a fit function.
+ *
+ */
+class MANTIDQT_INDIRECT_DLL MSDTemplateBrowser
+ : public FunctionTemplateBrowser {
+ Q_OBJECT
+public:
+ explicit MSDTemplateBrowser(QWidget *parent = nullptr);
+ virtual ~MSDTemplateBrowser() = default;
+ void addGaussian();
+ void removeGaussian();
+ void addPeters();
+ void removePeters();
+ void addYi();
+ void removeYi();
+
+ void setGaussianHeight(double, double);
+ void setGaussianMsd(double, double);
+ void setPetersHeight(double, double);
+ void setPetersMsd(double, double);
+ void setPetersBeta(double, double);
+ void setYiHeight(double, double);
+ void setYiMsd(double, double);
+ void setYiSigma(double, double);
+
+ void setFunction(const QString &funStr) override;
+ IFunction_sptr getGlobalFunction() const override;
+ IFunction_sptr getFunction() const override;
+ void setNumberOfDatasets(int) override;
+ int getNumberOfDatasets() const override;
+ void setDatasetNames(const QStringList &names) override;
+ QStringList getGlobalParameters() const override;
+ QStringList getLocalParameters() const override;
+ void setGlobalParameters(const QStringList &globals) override;
+ void updateMultiDatasetParameters(const IFunction &fun) override;
+ void updateMultiDatasetParameters(const ITableWorkspace ¶mTable) override;
+ void updateParameters(const IFunction &fun) override;
+ void setCurrentDataset(int i) override;
+ void updateParameterNames(const QMap<int, QString> ¶meterNames) override;
+ void
+ updateParameterDescriptions(const QMap<int, std::string> ¶meterNames);
+ void setErrorsEnabled(bool enabled) override;
+ void clear() override;
+ void updateParameterEstimationData(
+ DataForParameterEstimationCollection &&data) override;
+ void setBackgroundA0(double) override;
+ void setResolution(std::string const &, TableDatasetIndex const &) override;
+ void setResolution(const std::vector<std::pair<std::string, int>> &) override;
+ void setQValues(const std::vector<double> &) override;
+ int getCurrentDataset() override;
+
+protected slots:
+ void enumChanged(QtProperty *) override;
+ void globalChanged(QtProperty *, const QString &, bool) override;
+ void parameterChanged(QtProperty *) override;
+ void parameterButtonClicked(QtProperty *) override;
+
+private:
+ void createProperties() override;
+ void popupMenu(const QPoint &) override;
+ void setParameterPropertyValue(QtProperty *prop, double value, double error);
+ void setGlobalParametersQuiet(const QStringList &globals);
+
+ QtProperty *m_fitType;
+ QtProperty *m_gaussianHeight = nullptr;
+ QtProperty *m_gaussianMsd = nullptr;
+ QtProperty *m_petersHeight = nullptr;
+ QtProperty *m_petersMsd = nullptr;
+ QtProperty *m_petersBeta = nullptr;
+ QtProperty *m_yiHeight = nullptr;
+ QtProperty *m_yiMsd = nullptr;
+ QtProperty *m_yiSigma = nullptr;
+ QMap<QtProperty *, int> m_parameterMap;
+ QMap<QtProperty *, QString> m_actualParameterNames;
+ QMap<QtProperty *, std::string> m_parameterDescriptions;
+
+private:
+ MSDTemplatePresenter m_presenter;
+ bool m_emitParameterValueChange = true;
+ bool m_emitBoolChange = true;
+ bool m_emitEnumChange = true;
+ friend class MSDTemplatePresenter;
+};
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
+
+#endif /*INDIRECT_MSDTEMPLATEBROWSER_H_*/
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplatePresenter.cpp b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplatePresenter.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..7de651c63a8383767c14bd663c363baa7d1f6d7d
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplatePresenter.cpp
@@ -0,0 +1,293 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "MSDTemplatePresenter.h"
+#include "MSDTemplateBrowser.h"
+#include "MantidQtWidgets/Common/EditLocalParameterDialog.h"
+#include <math.h>
+
+namespace MantidQt {
+namespace CustomInterfaces {
+namespace IDA {
+
+using namespace MantidWidgets;
+
+/**
+ * Constructor
+ * @param parent :: The parent widget.
+ */
+MSDTemplatePresenter::MSDTemplatePresenter(MSDTemplateBrowser *view)
+ : QObject(view), m_view(view) {
+ connect(m_view, SIGNAL(localParameterButtonClicked(const QString &)), this,
+ SLOT(editLocalParameter(const QString &)));
+ connect(m_view, SIGNAL(parameterValueChanged(const QString &, double)), this,
+ SLOT(viewChangedParameterValue(const QString &, double)));
+}
+
+void MSDTemplatePresenter::setFitType(const QString &name) {
+ m_view->clear();
+ m_model.removeFitType();
+
+ if (name == "None") {
+ // do nothing
+ } else if (name == "Gaussian") {
+ m_view->addGaussian();
+ m_model.setFitType("MsdGauss");
+ } else if (name == "Peters") {
+ m_view->addPeters();
+ m_model.setFitType("MsdPeters");
+ } else if (name == "Yi") {
+ m_view->addYi();
+ m_model.setFitType("MsdYi");
+ } else {
+ throw std::logic_error("Browser doesn't support fit type " +
+ name.toStdString());
+ }
+ setErrorsEnabled(false);
+ updateView();
+ emit functionStructureChanged();
+}
+
+void MSDTemplatePresenter::setNumberOfDatasets(int n) {
+ m_model.setNumberDomains(n);
+}
+
+int MSDTemplatePresenter::getNumberOfDatasets() const {
+ return m_model.getNumberDomains();
+}
+
+int MSDTemplatePresenter::getCurrentDataset() {
+ return m_model.currentDomainIndex();
+}
+
+void MSDTemplatePresenter::setFunction(const QString &funStr) {
+ m_model.setFunctionString(funStr);
+ m_view->clear();
+ setErrorsEnabled(false);
+ if (m_model.hasGaussianType()) {
+ m_view->addGaussian();
+ }
+ if (m_model.hasPetersType()) {
+ m_view->addPeters();
+ }
+ if (m_model.hasYiType()) {
+ m_view->addYi();
+ }
+ updateViewParameterNames();
+ updateViewParameters();
+ emit functionStructureChanged();
+}
+
+IFunction_sptr MSDTemplatePresenter::getGlobalFunction() const {
+ return m_model.getFitFunction();
+}
+
+IFunction_sptr MSDTemplatePresenter::getFunction() const {
+ return m_model.getCurrentFunction();
+}
+
+QStringList MSDTemplatePresenter::getGlobalParameters() const {
+ return m_model.getGlobalParameters();
+}
+
+QStringList MSDTemplatePresenter::getLocalParameters() const {
+ return m_model.getLocalParameters();
+}
+
+void MSDTemplatePresenter::setGlobalParameters(const QStringList &globals) {
+ m_model.setGlobalParameters(globals);
+ m_view->setGlobalParametersQuiet(globals);
+}
+
+void MSDTemplatePresenter::setGlobal(const QString &parName, bool on) {
+ m_model.setGlobal(parName, on);
+ m_view->setGlobalParametersQuiet(m_model.getGlobalParameters());
+}
+
+void MSDTemplatePresenter::updateMultiDatasetParameters(const IFunction &fun) {
+ m_model.updateMultiDatasetParameters(fun);
+ updateViewParameters();
+}
+
+void MSDTemplatePresenter::updateMultiDatasetParameters(
+ const ITableWorkspace ¶mTable) {
+ m_model.updateMultiDatasetParameters(paramTable);
+ updateViewParameters();
+}
+
+void MSDTemplatePresenter::updateParameters(const IFunction &fun) {
+ m_model.updateParameters(fun);
+ updateViewParameters();
+}
+
+void MSDTemplatePresenter::setCurrentDataset(int i) {
+ m_model.setCurrentDomainIndex(i);
+ updateViewParameters();
+}
+
+void MSDTemplatePresenter::setDatasetNames(const QStringList &names) {
+ m_model.setDatasetNames(names);
+}
+
+void MSDTemplatePresenter::setViewParameterDescriptions() {
+ m_view->updateParameterDescriptions(m_model.getParameterDescriptionMap());
+}
+
+void MSDTemplatePresenter::setErrorsEnabled(bool enabled) {
+ m_view->setErrorsEnabled(enabled);
+}
+
+void MSDTemplatePresenter::updateParameterEstimationData(
+ DataForParameterEstimationCollection &&data) {
+ m_model.updateParameterEstimationData(std::move(data));
+}
+
+void MSDTemplatePresenter::updateViewParameters() {
+ static std::map<MSDFunctionModel::ParamID,
+ void (MSDTemplateBrowser::*)(double, double)>
+ setters{
+ {MSDFunctionModel::ParamID::GAUSSIAN_HEIGHT,
+ &MSDTemplateBrowser::setGaussianHeight},
+ {MSDFunctionModel::ParamID::GAUSSIAN_MSD,
+ &MSDTemplateBrowser::setGaussianMsd},
+ {MSDFunctionModel::ParamID::PETERS_HEIGHT,
+ &MSDTemplateBrowser::setPetersHeight},
+ {MSDFunctionModel::ParamID::PETERS_MSD,
+ &MSDTemplateBrowser::setPetersMsd},
+ {MSDFunctionModel::ParamID::PETERS_BETA,
+ &MSDTemplateBrowser::setPetersBeta},
+ {MSDFunctionModel::ParamID::YI_HEIGHT,
+ &MSDTemplateBrowser::setYiHeight},
+ {MSDFunctionModel::ParamID::YI_MSD, &MSDTemplateBrowser::setYiMsd},
+ {MSDFunctionModel::ParamID::YI_SIGMA,
+ &MSDTemplateBrowser::setYiSigma}};
+ const auto values = m_model.getCurrentValues();
+ const auto errors = m_model.getCurrentErrors();
+ for (auto const &name : values.keys()) {
+ (m_view->*setters.at(name))(values[name], errors[name]);
+ }
+}
+
+QStringList MSDTemplatePresenter::getDatasetNames() const {
+ return m_model.getDatasetNames();
+}
+
+double MSDTemplatePresenter::getLocalParameterValue(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterValue(parName, i);
+}
+
+bool MSDTemplatePresenter::isLocalParameterFixed(const QString &parName,
+ int i) const {
+ return m_model.isLocalParameterFixed(parName, i);
+}
+
+QString MSDTemplatePresenter::getLocalParameterTie(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterTie(parName, i);
+}
+
+QString
+MSDTemplatePresenter::getLocalParameterConstraint(const QString &parName,
+ int i) const {
+ return m_model.getLocalParameterConstraint(parName, i);
+}
+
+void MSDTemplatePresenter::setLocalParameterValue(const QString &parName, int i,
+ double value) {
+ m_model.setLocalParameterValue(parName, i, value);
+}
+
+void MSDTemplatePresenter::setLocalParameterTie(const QString &parName, int i,
+ const QString &tie) {
+ m_model.setLocalParameterTie(parName, i, tie);
+}
+
+void MSDTemplatePresenter::updateViewParameterNames() {
+ m_view->updateParameterNames(m_model.getParameterNameMap());
+}
+
+void MSDTemplatePresenter::updateView() {
+ updateViewParameterNames();
+ updateViewParameters();
+}
+
+void MSDTemplatePresenter::setLocalParameterFixed(const QString &parName, int i,
+ bool fixed) {
+ m_model.setLocalParameterFixed(parName, i, fixed);
+}
+
+void MSDTemplatePresenter::editLocalParameter(const QString &parName) {
+ auto const wsNames = getDatasetNames();
+ QList<double> values;
+ QList<bool> fixes;
+ QStringList ties;
+ QStringList constraints;
+ const int n = wsNames.size();
+ for (auto i = 0; i < n; ++i) {
+ const double value = getLocalParameterValue(parName, i);
+ values.push_back(value);
+ const bool fixed = isLocalParameterFixed(parName, i);
+ fixes.push_back(fixed);
+ const auto tie = getLocalParameterTie(parName, i);
+ ties.push_back(tie);
+ const auto constraint = getLocalParameterConstraint(parName, i);
+ constraints.push_back(constraint);
+ }
+
+ m_editLocalParameterDialog = new EditLocalParameterDialog(
+ m_view, parName, wsNames, values, fixes, ties, constraints);
+ connect(m_editLocalParameterDialog, SIGNAL(finished(int)), this,
+ SLOT(editLocalParameterFinish(int)));
+ m_editLocalParameterDialog->open();
+}
+
+void MSDTemplatePresenter::editLocalParameterFinish(int result) {
+ if (result == QDialog::Accepted) {
+ const auto parName = m_editLocalParameterDialog->getParameterName();
+ const auto values = m_editLocalParameterDialog->getValues();
+ const auto fixes = m_editLocalParameterDialog->getFixes();
+ const auto ties = m_editLocalParameterDialog->getTies();
+ assert(values.size() == getNumberOfDatasets());
+ for (int i = 0; i < values.size(); ++i) {
+ setLocalParameterValue(parName, i, values[i]);
+ if (!ties[i].isEmpty()) {
+ setLocalParameterTie(parName, i, ties[i]);
+ } else if (fixes[i]) {
+ setLocalParameterFixed(parName, i, fixes[i]);
+ } else {
+ setLocalParameterTie(parName, i, "");
+ }
+ }
+ }
+ m_editLocalParameterDialog = nullptr;
+ updateViewParameters();
+ emit functionStructureChanged();
+}
+
+void MSDTemplatePresenter::viewChangedParameterValue(const QString &parName,
+ double value) {
+ if (parName.isEmpty())
+ return;
+ if (m_model.isGlobal(parName)) {
+ const auto n = getNumberOfDatasets();
+ for (int i = 0; i < n; ++i) {
+ setLocalParameterValue(parName, i, value);
+ }
+ } else {
+ const auto i = m_model.currentDomainIndex();
+ const auto oldValue = m_model.getLocalParameterValue(parName, i);
+ if (fabs(value - oldValue) > 1e-6) {
+ setErrorsEnabled(false);
+ }
+ setLocalParameterValue(parName, i, value);
+ }
+ emit functionStructureChanged();
+}
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
diff --git a/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplatePresenter.h b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplatePresenter.h
new file mode 100644
index 0000000000000000000000000000000000000000..5336d3949b510fd46399156332f8b6f9a77d1ebb
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/IndirectFunctionBrowser/MSDTemplatePresenter.h
@@ -0,0 +1,88 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef INDIRECT_MSDTEMPLATEPRESENTER_H_
+#define INDIRECT_MSDTEMPLATEPRESENTER_H_
+
+#include "DllConfig.h"
+#include "MSDFunctionModel.h"
+#include "ParameterEstimation.h"
+
+#include <QMap>
+#include <QWidget>
+
+class QtProperty;
+
+namespace MantidQt {
+namespace MantidWidgets {
+class EditLocalParameterDialog;
+}
+namespace CustomInterfaces {
+namespace IDA {
+
+class MSDTemplateBrowser;
+
+/**
+ * Class FunctionTemplateBrowser implements QtPropertyBrowser to display
+ * and set properties that can be used to generate a fit function.
+ *
+ */
+class MANTIDQT_INDIRECT_DLL MSDTemplatePresenter : public QObject {
+ Q_OBJECT
+public:
+ explicit MSDTemplatePresenter(MSDTemplateBrowser *view);
+ void setFitType(const QString &name);
+
+ void setNumberOfDatasets(int);
+ int getNumberOfDatasets() const;
+ int getCurrentDataset();
+ void setFunction(const QString &funStr);
+ IFunction_sptr getGlobalFunction() const;
+ IFunction_sptr getFunction() const;
+ QStringList getGlobalParameters() const;
+ QStringList getLocalParameters() const;
+ void setGlobalParameters(const QStringList &globals);
+ void setGlobal(const QString &parName, bool on);
+ void updateMultiDatasetParameters(const IFunction &fun);
+ void updateMultiDatasetParameters(const ITableWorkspace ¶mTable);
+ void updateParameters(const IFunction &fun);
+ void setCurrentDataset(int i);
+ void setDatasetNames(const QStringList &names);
+ void setViewParameterDescriptions();
+ void setErrorsEnabled(bool enabled);
+ void
+ updateParameterEstimationData(DataForParameterEstimationCollection &&data);
+
+signals:
+ void functionStructureChanged();
+
+private slots:
+ void editLocalParameter(const QString &parName);
+ void editLocalParameterFinish(int result);
+ void viewChangedParameterValue(const QString &parName, double value);
+
+private:
+ void updateViewParameters();
+ QStringList getDatasetNames() const;
+ double getLocalParameterValue(const QString &parName, int i) const;
+ bool isLocalParameterFixed(const QString &parName, int i) const;
+ QString getLocalParameterTie(const QString &parName, int i) const;
+ QString getLocalParameterConstraint(const QString &parName, int i) const;
+ void setLocalParameterValue(const QString &parName, int i, double value);
+ void setLocalParameterFixed(const QString &parName, int i, bool fixed);
+ void setLocalParameterTie(const QString &parName, int i, const QString &tie);
+ void updateViewParameterNames();
+ void updateView();
+ MSDTemplateBrowser *m_view;
+ MSDFunctionModel m_model;
+ EditLocalParameterDialog *m_editLocalParameterDialog;
+};
+
+} // namespace IDA
+} // namespace CustomInterfaces
+} // namespace MantidQt
+
+#endif /*INDIRECT_MSDTEMPLATEPRESENTER_H_*/
diff --git a/qt/scientific_interfaces/Indirect/IndirectTab.cpp b/qt/scientific_interfaces/Indirect/IndirectTab.cpp
index c82a027c722127bd6d252fc68593fe9ccbe8307f..106ac2d06b1ad51f2bde46e9bdfdea4efcc318a8 100644
--- a/qt/scientific_interfaces/Indirect/IndirectTab.cpp
+++ b/qt/scientific_interfaces/Indirect/IndirectTab.cpp
@@ -154,8 +154,6 @@ IndirectTab::IndirectTab(QObject *parent)
//----------------------------------------------------------------------------------------------
/** Destructor
*/
-IndirectTab::~IndirectTab() {}
-
void IndirectTab::runTab() {
if (validate()) {
m_tabStartTime = DateAndTime::getCurrentTime();
diff --git a/qt/scientific_interfaces/Indirect/IndirectTab.h b/qt/scientific_interfaces/Indirect/IndirectTab.h
index 322c5fa75927c3b1c06f205bab01e55315b8ee8a..75443862203797a6df546e1d4c89b564bbd77c57 100644
--- a/qt/scientific_interfaces/Indirect/IndirectTab.h
+++ b/qt/scientific_interfaces/Indirect/IndirectTab.h
@@ -66,7 +66,7 @@ class MANTIDQT_INDIRECT_DLL IndirectTab : public QObject, public IPyRunner {
public:
IndirectTab(QObject *parent = nullptr);
- ~IndirectTab() override;
+ virtual ~IndirectTab() override = default;
/// Get the suffixes used for an interface from the xml file
QStringList getExtensions(std::string const &interfaceName) const;
diff --git a/qt/scientific_interfaces/Indirect/JumpFit.cpp b/qt/scientific_interfaces/Indirect/JumpFit.cpp
index fcdc9f410bd65b3fefcfdf9673f5d3ad1f383be3..7f3e78f801825229da87c890d419d7f626b1d218 100644
--- a/qt/scientific_interfaces/Indirect/JumpFit.cpp
+++ b/qt/scientific_interfaces/Indirect/JumpFit.cpp
@@ -5,6 +5,7 @@
// & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
#include "JumpFit.h"
+#include "IndirectFunctionBrowser/FQTemplateBrowser.h"
#include "JumpFitDataPresenter.h"
#include "MantidAPI/AlgorithmManager.h"
@@ -23,74 +24,48 @@
using namespace Mantid::API;
-namespace {
-
-std::vector<std::string> getEISFFunctions() {
- return {"EISFDiffCylinder", "EISFDiffSphere", "EISFDiffSphereAlkyl"};
-}
-
-std::vector<std::string> getWidthFunctions() {
- return {"ChudleyElliot", "HallRoss", "FickDiffusion", "TeixeiraWater"};
-}
-
-} // namespace
-
namespace MantidQt {
namespace CustomInterfaces {
namespace IDA {
JumpFit::JumpFit(QWidget *parent)
- : IndirectFitAnalysisTabLegacy(new JumpFitModel, parent),
+ : IndirectFitAnalysisTab(new JumpFitModel, parent),
m_uiForm(new Ui::JumpFit) {
m_uiForm->setupUi(parent);
m_jumpFittingModel = dynamic_cast<JumpFitModel *>(fittingModel());
+ auto templateBrowser = new FQTemplateBrowser;
+ setPlotView(m_uiForm->pvFitPlotView);
setFitDataPresenter(std::make_unique<JumpFitDataPresenter>(
m_jumpFittingModel, m_uiForm->fitDataView, m_uiForm->cbParameterType,
- m_uiForm->cbParameter, m_uiForm->lbParameterType, m_uiForm->lbParameter));
- setPlotView(m_uiForm->pvFitPlotView);
+ m_uiForm->cbParameter, m_uiForm->lbParameterType, m_uiForm->lbParameter,
+ templateBrowser));
+ connect(m_dataPresenter.get(), SIGNAL(spectrumChanged(WorkspaceIndex)),
+ m_plotPresenter.get(),
+ SLOT(handlePlotSpectrumChanged(WorkspaceIndex)));
setSpectrumSelectionView(m_uiForm->svSpectrumView);
setOutputOptionsView(m_uiForm->ovOutputOptionsView);
+
+ m_uiForm->fitPropertyBrowser->setFunctionTemplateBrowser(templateBrowser);
setFitPropertyBrowser(m_uiForm->fitPropertyBrowser);
setEditResultVisible(false);
+ m_uiForm->fitDataView->setStartAndEndHidden(false);
}
void JumpFit::setupFitTab() {
m_uiForm->svSpectrumView->hideSpectrumSelector();
m_uiForm->svSpectrumView->hideMaskSpectrumSelector();
- addFunctions(getWidthFunctions());
- addFunctions(getEISFFunctions());
-
m_uiForm->cbParameter->setEnabled(false);
- // Handle plotting and saving
connect(m_uiForm->pbRun, SIGNAL(clicked()), this, SLOT(runClicked()));
- connect(this, SIGNAL(functionChanged()), this,
- SLOT(updateModelFitTypeString()));
connect(m_uiForm->cbParameterType, SIGNAL(currentIndexChanged(int)), this,
SLOT(updateAvailableFitTypes()));
connect(this, SIGNAL(updateAvailableFitTypes()), this,
SLOT(updateAvailableFitTypes()));
}
-void JumpFit::updateAvailableFitTypes() {
- auto const parameter = m_uiForm->cbParameterType->currentText().toStdString();
- clearFitTypeComboBox();
- if (parameter == "Width")
- addFunctions(getWidthFunctions());
- else if (parameter == "EISF")
- addFunctions(getEISFFunctions());
-}
-
-void JumpFit::addFunctions(std::vector<std::string> const &functions) {
- auto &factory = FunctionFactory::Instance();
- for (auto const &function : functions)
- addComboBoxFunctionGroup(QString::fromStdString(function),
- {factory.createFunction(function)});
-}
-
void JumpFit::updateModelFitTypeString() {
m_jumpFittingModel->setFitType(selectedFitType().toStdString());
}
@@ -105,6 +80,13 @@ void JumpFit::setRunEnabled(bool enable) {
m_uiForm->pbRun->setEnabled(enable);
}
+EstimationDataSelector JumpFit::getEstimationDataSelector() const {
+ return [](const std::vector<double> &,
+ const std::vector<double> &) -> DataForParameterEstimation {
+ return DataForParameterEstimation{};
+ };
+}
+
} // namespace IDA
} // namespace CustomInterfaces
} // namespace MantidQt
diff --git a/qt/scientific_interfaces/Indirect/JumpFit.h b/qt/scientific_interfaces/Indirect/JumpFit.h
index 3532245d5b831baa4d8c93e3fe8b291c6fad5b13..399079e9d763d3cf4f213c72b02988a866ea475d 100644
--- a/qt/scientific_interfaces/Indirect/JumpFit.h
+++ b/qt/scientific_interfaces/Indirect/JumpFit.h
@@ -7,7 +7,7 @@
#ifndef MANTIDQTCUSTOMINTERFACES_JUMPFIT_H_
#define MANTIDQTCUSTOMINTERFACES_JUMPFIT_H_
-#include "IndirectFitAnalysisTabLegacy.h"
+#include "IndirectFitAnalysisTab.h"
#include "JumpFitModel.h"
#include "ui_JumpFit.h"
@@ -17,7 +17,7 @@
namespace MantidQt {
namespace CustomInterfaces {
namespace IDA {
-class DLLExport JumpFit : public IndirectFitAnalysisTabLegacy {
+class DLLExport JumpFit : public IndirectFitAnalysisTab {
Q_OBJECT
public:
@@ -37,11 +37,8 @@ protected:
void setRunIsRunning(bool running) override;
void setRunEnabled(bool enable) override;
-private slots:
- void updateAvailableFitTypes();
-
private:
- void addFunctions(std::vector<std::string> const &functions);
+ EstimationDataSelector getEstimationDataSelector() const override;
JumpFitModel *m_jumpFittingModel;
std::unique_ptr<Ui::JumpFit> m_uiForm;
diff --git a/qt/scientific_interfaces/Indirect/JumpFit.ui b/qt/scientific_interfaces/Indirect/JumpFit.ui
index d9f1a10ec7de9efb4ab140ce17cdc34ebc070f53..706f8b87500269788fbbe2143d4bf13b846ca326 100644
--- a/qt/scientific_interfaces/Indirect/JumpFit.ui
+++ b/qt/scientific_interfaces/Indirect/JumpFit.ui
@@ -22,13 +22,13 @@
<property name="childrenCollapsible">
<bool>false</bool>
</property>
- <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitDataViewLegacy" name="fitDataView" native="true"/>
+ <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitDataView" name="fitDataView" native="true"/>
<widget class="QWidget" name="layoutWidget">
<layout class="QVBoxLayout" name="verticalLayout">
<item>
<layout class="QHBoxLayout" name="loPlotArea" stretch="1,1">
<item>
- <widget class="MantidQt::MantidWidgets::IndirectFitPropertyBrowserLegacy" name="fitPropertyBrowser">
+ <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitPropertyBrowser" name="fitPropertyBrowser">
<widget class="QWidget" name="dockWidgetContents"/>
</widget>
</item>
@@ -125,12 +125,12 @@
</layout>
</item>
<item>
- <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitPlotViewLegacy" name="pvFitPlotView" native="true"/>
+ <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitPlotView" name="pvFitPlotView" native="true"/>
</item>
</layout>
</item>
<item>
- <widget class="MantidQt::CustomInterfaces::IDA::IndirectSpectrumSelectionViewLegacy" name="svSpectrumView" native="true"/>
+ <widget class="MantidQt::CustomInterfaces::IDA::IndirectSpectrumSelectionView" name="svSpectrumView" native="true"/>
</item>
</layout>
</item>
@@ -142,16 +142,7 @@
<property name="spacing">
<number>0</number>
</property>
- <property name="leftMargin">
- <number>0</number>
- </property>
- <property name="topMargin">
- <number>0</number>
- </property>
- <property name="rightMargin">
- <number>0</number>
- </property>
- <property name="bottomMargin">
+ <property name="margin">
<number>0</number>
</property>
<item>
@@ -216,27 +207,21 @@
</widget>
<customwidgets>
<customwidget>
- <class>MantidQt::CustomInterfaces::IDA::IndirectSpectrumSelectionViewLegacy</class>
+ <class>MantidQt::CustomInterfaces::IDA::IndirectSpectrumSelectionView</class>
<extends>QWidget</extends>
- <header>IndirectSpectrumSelectionViewLegacy.h</header>
- <container>1</container>
- </customwidget>
- <customwidget>
- <class>MantidQt::MantidWidgets::IndirectFitPropertyBrowserLegacy</class>
- <extends>QDockWidget</extends>
- <header>MantidQtWidgets/Common/IndirectFitPropertyBrowserLegacy.h</header>
+ <header>IndirectSpectrumSelectionView.h</header>
<container>1</container>
</customwidget>
<customwidget>
- <class>MantidQt::CustomInterfaces::IDA::IndirectFitPlotViewLegacy</class>
+ <class>MantidQt::CustomInterfaces::IDA::IndirectFitPlotView</class>
<extends>QWidget</extends>
- <header>IndirectFitPlotViewLegacy.h</header>
+ <header>IndirectFitPlotView.h</header>
<container>1</container>
</customwidget>
<customwidget>
- <class>MantidQt::CustomInterfaces::IDA::IndirectFitDataViewLegacy</class>
+ <class>MantidQt::CustomInterfaces::IDA::IndirectFitDataView</class>
<extends>QWidget</extends>
- <header>IndirectFitDataViewLegacy.h</header>
+ <header>IndirectFitDataView.h</header>
<container>1</container>
</customwidget>
<customwidget>
@@ -245,6 +230,12 @@
<header>IndirectFitOutputOptionsView.h</header>
<container>1</container>
</customwidget>
+ <customwidget>
+ <class>MantidQt::CustomInterfaces::IDA::IndirectFitPropertyBrowser</class>
+ <extends>QDockWidget</extends>
+ <header>IndirectFitPropertyBrowser.h</header>
+ <container>1</container>
+ </customwidget>
</customwidgets>
<resources/>
<connections/>
diff --git a/qt/scientific_interfaces/Indirect/JumpFitDataPresenter.cpp b/qt/scientific_interfaces/Indirect/JumpFitDataPresenter.cpp
index ae5bfb14e2cf83f2ef5ff2be84da16a2fbab0b95..64adba9727216a0abea5afe049f35091203dd53a 100644
--- a/qt/scientific_interfaces/Indirect/JumpFitDataPresenter.cpp
+++ b/qt/scientific_interfaces/Indirect/JumpFitDataPresenter.cpp
@@ -13,17 +13,14 @@ namespace MantidQt {
namespace CustomInterfaces {
namespace IDA {
-JumpFitDataPresenter::JumpFitDataPresenter(JumpFitModel *model,
- IIndirectFitDataViewLegacy *view,
- QComboBox *cbParameterType,
- QComboBox *cbParameter,
- QLabel *lbParameterType,
- QLabel *lbParameter)
- : IndirectFitDataPresenterLegacy(
- model, view,
- std::make_unique<JumpFitDataTablePresenter>(model,
- view->getDataTable())),
- m_activeParameterType("Width"), m_dataIndex(0),
+JumpFitDataPresenter::JumpFitDataPresenter(
+ JumpFitModel *model, IIndirectFitDataView *view, QComboBox *cbParameterType,
+ QComboBox *cbParameter, QLabel *lbParameterType, QLabel *lbParameter,
+ IFQFitObserver *fQTemplateBrowser)
+ : IndirectFitDataPresenter(model, view,
+ std::make_unique<JumpFitDataTablePresenter>(
+ model, view->getDataTable())),
+ m_activeParameterType("Width"), m_dataIndex(TableDatasetIndex{0}),
m_cbParameterType(cbParameterType), m_cbParameter(cbParameter),
m_lbParameterType(lbParameterType), m_lbParameter(lbParameter),
m_jumpModel(model) {
@@ -36,15 +33,9 @@ JumpFitDataPresenter::JumpFitDataPresenter(JumpFitModel *model,
SLOT(updateActiveDataIndex()));
connect(cbParameterType, SIGNAL(currentIndexChanged(const QString &)), this,
- SLOT(setParameterLabel(const QString &)));
- connect(cbParameterType, SIGNAL(currentIndexChanged(const QString &)), this,
- SLOT(updateAvailableParameters(QString const &)));
- connect(cbParameterType, SIGNAL(currentIndexChanged(const QString &)), this,
- SIGNAL(dataChanged()));
+ SLOT(handleParameterTypeChanged(const QString &)));
connect(cbParameter, SIGNAL(currentIndexChanged(int)), this,
- SLOT(setSingleModelSpectrum(int)));
- connect(cbParameter, SIGNAL(currentIndexChanged(int)), this,
- SIGNAL(dataChanged()));
+ SLOT(handleSpectrumSelectionChanged(int)));
connect(view, SIGNAL(sampleLoaded(const QString &)), this,
SLOT(updateAvailableParameterTypes()));
@@ -56,6 +47,8 @@ JumpFitDataPresenter::JumpFitDataPresenter(JumpFitModel *model,
SIGNAL(updateAvailableFitTypes()));
updateParameterSelectionEnabled();
+ m_notifier = Notifier<IFQFitObserver>();
+ m_notifier.subscribe(fQTemplateBrowser);
}
void JumpFitDataPresenter::hideParameterComboBoxes() {
@@ -86,9 +79,9 @@ void JumpFitDataPresenter::updateAvailableParameters() {
void JumpFitDataPresenter::updateAvailableParameters(const QString &type) {
if (type == "Width")
- setAvailableParameters(m_jumpModel->getWidths(0));
+ setAvailableParameters(m_jumpModel->getWidths(TableDatasetIndex{0}));
else if (type == "EISF")
- setAvailableParameters(m_jumpModel->getEISF(0));
+ setAvailableParameters(m_jumpModel->getEISF(TableDatasetIndex{0}));
else
setAvailableParameters({});
@@ -104,7 +97,7 @@ void JumpFitDataPresenter::updateAvailableParameterTypes() {
}
void JumpFitDataPresenter::updateParameterSelectionEnabled() {
- const auto enabled = m_jumpModel->numberOfWorkspaces() > 0;
+ const auto enabled = m_jumpModel->numberOfWorkspaces() > TableDatasetIndex{0};
m_cbParameter->setEnabled(enabled);
m_cbParameterType->setEnabled(enabled);
m_lbParameter->setEnabled(enabled);
@@ -122,6 +115,17 @@ void JumpFitDataPresenter::setParameterLabel(const QString ¶meter) {
m_lbParameter->setText(parameter + ":");
}
+void JumpFitDataPresenter::handleParameterTypeChanged(
+ const QString ¶meter) {
+ m_lbParameter->setText(parameter + ":");
+ updateAvailableParameters(parameter);
+ auto dataType =
+ parameter == QString("Width") ? DataType::WIDTH : DataType::EISF;
+ m_notifier.notify(
+ [&dataType](IFQFitObserver &obs) { obs.updateDataType(dataType); });
+ emit dataChanged();
+}
+
void JumpFitDataPresenter::setDialogParameterNames(
JumpFitAddWorkspaceDialog *dialog, const std::string &workspace) {
try {
@@ -156,7 +160,7 @@ void JumpFitDataPresenter::updateParameterTypes(
}
std::vector<std::string>
-JumpFitDataPresenter::getParameterTypes(std::size_t dataIndex) const {
+JumpFitDataPresenter::getParameterTypes(TableDatasetIndex dataIndex) const {
std::vector<std::string> types;
if (!m_jumpModel->zeroWidths(dataIndex))
types.emplace_back("Width");
@@ -165,7 +169,7 @@ JumpFitDataPresenter::getParameterTypes(std::size_t dataIndex) const {
return types;
}
-void JumpFitDataPresenter::addWorkspace(IndirectFittingModelLegacy *model,
+void JumpFitDataPresenter::addWorkspace(IndirectFittingModel *model,
const std::string &name) {
if (model->numberOfWorkspaces() > m_dataIndex)
model->removeWorkspace(m_dataIndex);
@@ -183,9 +187,19 @@ void JumpFitDataPresenter::addDataToModel(IAddWorkspaceDialog const *dialog) {
void JumpFitDataPresenter::setSingleModelSpectrum(int parameterIndex) {
auto index = static_cast<std::size_t>(parameterIndex);
if (m_cbParameterType->currentIndex() == 0)
- m_jumpModel->setActiveWidth(index, 0);
+ m_jumpModel->setActiveWidth(index, TableDatasetIndex{0});
else
- m_jumpModel->setActiveEISF(index, 0);
+ m_jumpModel->setActiveEISF(index, TableDatasetIndex{0});
+}
+
+void JumpFitDataPresenter::handleSpectrumSelectionChanged(int parameterIndex) {
+ // setSingleModelSpectrum(parameterIndex);
+ auto spectra =
+ m_jumpModel->getSpectra(m_dataIndex)[TableRowIndex{parameterIndex}];
+ m_notifier.notify([¶meterIndex](IFQFitObserver &obs) {
+ obs.spectrumChanged(parameterIndex);
+ });
+ emit spectrumChanged(spectra);
}
void JumpFitDataPresenter::setModelSpectrum(int index) {
@@ -200,7 +214,7 @@ void JumpFitDataPresenter::setModelSpectrum(int index) {
void JumpFitDataPresenter::closeDialog() {
if (m_jumpModel->numberOfWorkspaces() > m_dataIndex)
m_jumpModel->removeWorkspace(m_dataIndex);
- IndirectFitDataPresenterLegacy::closeDialog();
+ IndirectFitDataPresenter::closeDialog();
}
std::unique_ptr<IAddWorkspaceDialog>
diff --git a/qt/scientific_interfaces/Indirect/JumpFitDataPresenter.h b/qt/scientific_interfaces/Indirect/JumpFitDataPresenter.h
index e85921328c1c1596af5c10cec390741a8cfafcc5..b3628ffddf9c86c6b2c909ad0b1b0a6c0e91874c 100644
--- a/qt/scientific_interfaces/Indirect/JumpFitDataPresenter.h
+++ b/qt/scientific_interfaces/Indirect/JumpFitDataPresenter.h
@@ -7,9 +7,12 @@
#ifndef MANTIDQTCUSTOMINTERFACESIDA_JUMPFITDATAPRESENTER_H_
#define MANTIDQTCUSTOMINTERFACESIDA_JUMPFITDATAPRESENTER_H_
-#include "IndirectFitDataPresenterLegacy.h"
+#include "IFQFitObserver.h"
+#include "IndirectFitDataPresenter.h"
+#include "IndirectFunctionBrowser/FQTemplateBrowser.h"
#include "JumpFitAddWorkspaceDialog.h"
#include "JumpFitModel.h"
+#include "Notifier.h"
#include <QComboBox>
#include <QSpacerItem>
@@ -19,12 +22,13 @@ namespace CustomInterfaces {
namespace IDA {
class MANTIDQT_INDIRECT_DLL JumpFitDataPresenter
- : public IndirectFitDataPresenterLegacy {
+ : public IndirectFitDataPresenter {
Q_OBJECT
public:
- JumpFitDataPresenter(JumpFitModel *model, IIndirectFitDataViewLegacy *view,
+ JumpFitDataPresenter(JumpFitModel *model, IIndirectFitDataView *view,
QComboBox *cbParameterType, QComboBox *cbParameter,
- QLabel *lbParameterType, QLabel *lbParameter);
+ QLabel *lbParameterType, QLabel *lbParameter,
+ IFQFitObserver *fQTemplateBrowser);
private slots:
void hideParameterComboBoxes();
@@ -41,6 +45,11 @@ private slots:
void setActiveParameterType(const std::string &type);
void updateActiveDataIndex();
void setSingleModelSpectrum(int index);
+ void handleParameterTypeChanged(const QString ¶meter);
+ void handleSpectrumSelectionChanged(int parameterIndex);
+
+signals:
+ void spectrumChanged(WorkspaceIndex);
private:
void setAvailableParameters(const std::vector<std::string> ¶meters);
@@ -50,21 +59,22 @@ private:
getAddWorkspaceDialog(QWidget *parent) const override;
void updateParameterOptions(JumpFitAddWorkspaceDialog *dialog);
void updateParameterTypes(JumpFitAddWorkspaceDialog *dialog);
- std::vector<std::string> getParameterTypes(std::size_t dataIndex) const;
- void addWorkspace(IndirectFittingModelLegacy *model, const std::string &name);
+ std::vector<std::string> getParameterTypes(TableDatasetIndex dataIndex) const;
+ void addWorkspace(IndirectFittingModel *model, const std::string &name);
void setModelSpectrum(int index);
void setMultiInputResolutionFBSuffixes(IAddWorkspaceDialog *dialog) override;
void setMultiInputResolutionWSSuffixes(IAddWorkspaceDialog *dialog) override;
std::string m_activeParameterType;
- std::size_t m_dataIndex;
+ TableDatasetIndex m_dataIndex;
QComboBox *m_cbParameterType;
QComboBox *m_cbParameter;
QLabel *m_lbParameterType;
QLabel *m_lbParameter;
JumpFitModel *m_jumpModel;
+ Notifier<IFQFitObserver> m_notifier;
};
} // namespace IDA
diff --git a/qt/scientific_interfaces/Indirect/JumpFitDataTablePresenter.cpp b/qt/scientific_interfaces/Indirect/JumpFitDataTablePresenter.cpp
index 52ee7de0a8ad77056a85be813479d7227206b5c3..bf6c24528bc4782f21ed56c4cff8d4db2158bb85 100644
--- a/qt/scientific_interfaces/Indirect/JumpFitDataTablePresenter.cpp
+++ b/qt/scientific_interfaces/Indirect/JumpFitDataTablePresenter.cpp
@@ -28,7 +28,7 @@ namespace IDA {
JumpFitDataTablePresenter::JumpFitDataTablePresenter(JumpFitModel *model,
QTableWidget *dataTable)
- : IndirectDataTablePresenterLegacy(model, dataTable, jumpFitHeaders()),
+ : IndirectDataTablePresenter(model, dataTable, jumpFitHeaders()),
m_jumpFitModel(model) {
auto header = dataTable->horizontalHeader();
#if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
@@ -46,9 +46,10 @@ int JumpFitDataTablePresenter::endXColumn() const { return 4; }
int JumpFitDataTablePresenter::excludeColumn() const { return 5; }
-void JumpFitDataTablePresenter::addTableEntry(std::size_t dataIndex,
- std::size_t spectrum, int row) {
- IndirectDataTablePresenterLegacy::addTableEntry(dataIndex, spectrum, row);
+void JumpFitDataTablePresenter::addTableEntry(TableDatasetIndex dataIndex,
+ WorkspaceIndex spectrum,
+ TableRowIndex row) {
+ IndirectDataTablePresenter::addTableEntry(dataIndex, spectrum, row);
const auto parameter =
m_jumpFitModel->getFitParameterName(dataIndex, spectrum);
@@ -60,10 +61,10 @@ void JumpFitDataTablePresenter::addTableEntry(std::size_t dataIndex,
setCell(std::move(cell), row, 1);
}
-void JumpFitDataTablePresenter::updateTableEntry(std::size_t dataIndex,
- std::size_t spectrum,
- int row) {
- IndirectDataTablePresenterLegacy::updateTableEntry(dataIndex, spectrum, row);
+void JumpFitDataTablePresenter::updateTableEntry(TableDatasetIndex dataIndex,
+ WorkspaceIndex spectrum,
+ TableRowIndex row) {
+ IndirectDataTablePresenter::updateTableEntry(dataIndex, spectrum, row);
const auto parameter =
m_jumpFitModel->getFitParameterName(dataIndex, spectrum);
diff --git a/qt/scientific_interfaces/Indirect/JumpFitDataTablePresenter.h b/qt/scientific_interfaces/Indirect/JumpFitDataTablePresenter.h
index 8f58ee89e7a36e621985721e416a90cbb3397792..70161bfaf9739358697efb92fd7d4511a2b3071a 100644
--- a/qt/scientific_interfaces/Indirect/JumpFitDataTablePresenter.h
+++ b/qt/scientific_interfaces/Indirect/JumpFitDataTablePresenter.h
@@ -7,7 +7,7 @@
#ifndef MANTIDQTCUSTOMINTERFACES_JUMPFITDATATABLEPRESENTER_H_
#define MANTIDQTCUSTOMINTERFACES_JUMPFITDATATABLEPRESENTER_H_
-#include "IndirectDataTablePresenterLegacy.h"
+#include "IndirectDataTablePresenter.h"
#include "JumpFitModel.h"
#include <QTableWidget>
@@ -22,17 +22,16 @@ namespace IDA {
/**
Presenter for a table of data containing Widths/EISF.
*/
-class DLLExport JumpFitDataTablePresenter
- : public IndirectDataTablePresenterLegacy {
+class DLLExport JumpFitDataTablePresenter : public IndirectDataTablePresenter {
Q_OBJECT
public:
JumpFitDataTablePresenter(JumpFitModel *model, QTableWidget *dataTable);
protected:
- void addTableEntry(std::size_t dataIndex, std::size_t spectrum,
- int row) override;
- void updateTableEntry(std::size_t dataIndex, std::size_t spectrum,
- int row) override;
+ void addTableEntry(TableDatasetIndex dataIndex, WorkspaceIndex spectrum,
+ TableRowIndex row) override;
+ void updateTableEntry(TableDatasetIndex dataIndex, WorkspaceIndex spectrum,
+ TableRowIndex row) override;
private:
int workspaceIndexColumn() const override;
diff --git a/qt/scientific_interfaces/Indirect/JumpFitModel.cpp b/qt/scientific_interfaces/Indirect/JumpFitModel.cpp
index 47f9b8428082976f55213cc26b55ad3ae814b02e..e30ed67868b33897632143a60b071b6ada74c116 100644
--- a/qt/scientific_interfaces/Indirect/JumpFitModel.cpp
+++ b/qt/scientific_interfaces/Indirect/JumpFitModel.cpp
@@ -55,8 +55,12 @@ findAxisLabels(MatrixWorkspace const *workspace, Predicate const &predicate) {
return std::make_pair(std::vector<std::string>(), std::vector<std::size_t>());
}
-SpectraLegacy createSpectra(std::size_t spectrum) {
- return std::make_pair(spectrum, spectrum);
+std::string createSpectra(std::vector<std::size_t> spectrum) {
+ std::string spectra = "";
+ for (auto spec : spectrum) {
+ spectra.append(std::to_string(spec) + ",");
+ }
+ return spectra;
}
std::string getHWHMName(const std::string &resultName) {
@@ -198,12 +202,12 @@ createHWHMWorkspace(MatrixWorkspace_sptr workspace, const std::string &hwhmName,
return hwhmWorkspace;
}
-boost::optional<std::size_t>
-getFirstSpectrum(const JumpFitParameters ¶meters) {
+boost::optional<std::vector<std::size_t>>
+getSpectrum(const JumpFitParameters ¶meters) {
if (!parameters.widthSpectra.empty())
- return parameters.widthSpectra.front();
+ return parameters.widthSpectra;
else if (!parameters.eisfSpectra.empty())
- return parameters.eisfSpectra.front();
+ return parameters.eisfSpectra;
return boost::none;
}
} // namespace
@@ -213,11 +217,11 @@ namespace CustomInterfaces {
namespace IDA {
void JumpFitModel::addWorkspace(Mantid::API::MatrixWorkspace_sptr workspace,
- const SpectraLegacy & /*spectra*/) {
+ const Spectra & /*spectra*/) {
const auto name = getHWHMName(workspace->getName());
const auto parameters = addJumpFitParameters(workspace.get(), name);
- const auto spectrum = getFirstSpectrum(parameters);
+ const auto spectrum = getSpectrum(parameters);
if (!spectrum)
throw std::invalid_argument("Workspace contains no Width or EISF spectra.");
@@ -226,13 +230,13 @@ void JumpFitModel::addWorkspace(Mantid::API::MatrixWorkspace_sptr workspace,
const auto hwhmWorkspace =
createHWHMWorkspace(workspace, name, parameters.widthSpectra);
- IndirectFittingModelLegacy::addNewWorkspace(hwhmWorkspace,
- createSpectra(*spectrum));
+ IndirectFittingModel::addNewWorkspace(hwhmWorkspace,
+ Spectra(createSpectra(spectrum.get())));
}
-void JumpFitModel::removeWorkspace(std::size_t index) {
+void JumpFitModel::removeWorkspace(TableDatasetIndex index) {
m_jumpParameters.erase(getWorkspace(index)->getName());
- IndirectFittingModelLegacy::removeFittingData(index);
+ IndirectFittingModel::removeFittingData(index);
}
JumpFitParameters &
@@ -249,37 +253,38 @@ JumpFitModel::addJumpFitParameters(MatrixWorkspace *workspace,
}
std::unordered_map<std::string, JumpFitParameters>::const_iterator
-JumpFitModel::findJumpFitParameters(std::size_t dataIndex) const {
+JumpFitModel::findJumpFitParameters(TableDatasetIndex dataIndex) const {
const auto ws = getWorkspace(dataIndex);
if (!ws)
return m_jumpParameters.end();
return m_jumpParameters.find(ws->getName());
}
-std::string JumpFitModel::getFitParameterName(std::size_t dataIndex,
- std::size_t spectrum) const {
+std::string JumpFitModel::getFitParameterName(TableDatasetIndex dataIndex,
+ WorkspaceIndex spectrum) const {
const auto ws = getWorkspace(dataIndex);
const auto axis = dynamic_cast<TextAxis *>(ws->getAxis(1));
- return axis->label(spectrum);
+ return axis->label(spectrum.value);
}
void JumpFitModel::setActiveWidth(std::size_t widthIndex,
- std::size_t dataIndex) {
+ TableDatasetIndex dataIndex) {
const auto parametersIt = findJumpFitParameters(dataIndex);
if (parametersIt != m_jumpParameters.end() &&
parametersIt->second.widthSpectra.size() > widthIndex) {
const auto &widthSpectra = parametersIt->second.widthSpectra;
- setSpectra(createSpectra(widthSpectra[widthIndex]), dataIndex);
+ setSpectra(createSpectra(widthSpectra), dataIndex);
} else
throw std::runtime_error("Invalid width index specified.");
}
-void JumpFitModel::setActiveEISF(std::size_t eisfIndex, std::size_t dataIndex) {
+void JumpFitModel::setActiveEISF(std::size_t eisfIndex,
+ TableDatasetIndex dataIndex) {
const auto parametersIt = findJumpFitParameters(dataIndex);
if (parametersIt != m_jumpParameters.end() &&
parametersIt->second.eisfSpectra.size() > eisfIndex) {
const auto &eisfSpectra = parametersIt->second.eisfSpectra;
- setSpectra(createSpectra(eisfSpectra[eisfIndex]), dataIndex);
+ setSpectra(createSpectra(eisfSpectra), dataIndex);
} else
throw std::runtime_error("Invalid EISF index specified.");
}
@@ -288,14 +293,14 @@ void JumpFitModel::setFitType(const std::string &fitType) {
m_fitType = fitType;
}
-bool JumpFitModel::zeroWidths(std::size_t dataIndex) const {
+bool JumpFitModel::zeroWidths(TableDatasetIndex dataIndex) const {
const auto parameters = findJumpFitParameters(dataIndex);
if (parameters != m_jumpParameters.end())
return parameters->second.widths.empty();
return true;
}
-bool JumpFitModel::zeroEISF(std::size_t dataIndex) const {
+bool JumpFitModel::zeroEISF(TableDatasetIndex dataIndex) const {
const auto parameters = findJumpFitParameters(dataIndex);
if (parameters != m_jumpParameters.end())
return parameters->second.eisf.empty();
@@ -303,23 +308,25 @@ bool JumpFitModel::zeroEISF(std::size_t dataIndex) const {
}
bool JumpFitModel::isMultiFit() const {
- if (numberOfWorkspaces() == 0)
+ if (numberOfWorkspaces() == TableDatasetIndex{0})
return false;
- return !allWorkspacesEqual(getWorkspace(0));
+ return !allWorkspacesEqual(getWorkspace(TableDatasetIndex{0}));
}
std::vector<std::string> JumpFitModel::getSpectrumDependentAttributes() const {
return {};
}
-std::vector<std::string> JumpFitModel::getWidths(std::size_t dataIndex) const {
+std::vector<std::string>
+JumpFitModel::getWidths(TableDatasetIndex dataIndex) const {
const auto parameters = findJumpFitParameters(dataIndex);
if (parameters != m_jumpParameters.end())
return parameters->second.widths;
return std::vector<std::string>();
}
-std::vector<std::string> JumpFitModel::getEISF(std::size_t dataIndex) const {
+std::vector<std::string>
+JumpFitModel::getEISF(TableDatasetIndex dataIndex) const {
const auto parameters = findJumpFitParameters(dataIndex);
if (parameters != m_jumpParameters.end())
return parameters->second.eisf;
@@ -328,7 +335,7 @@ std::vector<std::string> JumpFitModel::getEISF(std::size_t dataIndex) const {
boost::optional<std::size_t>
JumpFitModel::getWidthSpectrum(std::size_t widthIndex,
- std::size_t dataIndex) const {
+ TableDatasetIndex dataIndex) const {
const auto parameters = findJumpFitParameters(dataIndex);
if (parameters != m_jumpParameters.end() &&
parameters->second.widthSpectra.size() > widthIndex)
@@ -338,7 +345,7 @@ JumpFitModel::getWidthSpectrum(std::size_t widthIndex,
boost::optional<std::size_t>
JumpFitModel::getEISFSpectrum(std::size_t eisfIndex,
- std::size_t dataIndex) const {
+ TableDatasetIndex dataIndex) const {
const auto parameters = findJumpFitParameters(dataIndex);
if (parameters != m_jumpParameters.end() &&
parameters->second.eisfSpectra.size() > eisfIndex)
@@ -356,8 +363,8 @@ std::string JumpFitModel::simultaneousFitOutputName() const {
return sequentialFitOutputName();
}
-std::string JumpFitModel::singleFitOutputName(std::size_t index,
- std::size_t spectrum) const {
+std::string JumpFitModel::singleFitOutputName(TableDatasetIndex index,
+ WorkspaceIndex spectrum) const {
return createSingleFitOutputName("%1%_FofQFit_" + m_fitType + "_s%2%_Results",
index, spectrum);
}
@@ -367,7 +374,8 @@ std::string JumpFitModel::getResultXAxisUnit() const { return ""; }
std::string JumpFitModel::getResultLogName() const { return "SourceName"; }
std::string JumpFitModel::constructOutputName() const {
- auto const name = createOutputName("%1%_FofQFit_" + m_fitType, "", 0);
+ auto const name =
+ createOutputName("%1%_FofQFit_" + m_fitType, "", TableDatasetIndex{0});
auto const position = name.find("_Result");
if (position != std::string::npos)
return name.substr(0, position) + name.substr(position + 7, name.size());
@@ -376,7 +384,7 @@ std::string JumpFitModel::constructOutputName() const {
bool JumpFitModel::allWorkspacesEqual(
Mantid::API::MatrixWorkspace_sptr workspace) const {
- for (auto i = 1u; i < numberOfWorkspaces(); ++i) {
+ for (auto i = TableDatasetIndex{1}; i < numberOfWorkspaces(); ++i) {
if (getWorkspace(i) != workspace)
return false;
}
diff --git a/qt/scientific_interfaces/Indirect/JumpFitModel.h b/qt/scientific_interfaces/Indirect/JumpFitModel.h
index 795f6e71693b27dd96a0806ce82bfceda920c711..d40fffbcbe94744f42250ee8973c11cf68553949 100644
--- a/qt/scientific_interfaces/Indirect/JumpFitModel.h
+++ b/qt/scientific_interfaces/Indirect/JumpFitModel.h
@@ -7,7 +7,7 @@
#ifndef MANTIDQTCUSTOMINTERFACESIDA_JUMPFITMODEL_H_
#define MANTIDQTCUSTOMINTERFACESIDA_JUMPFITMODEL_H_
-#include "IndirectFittingModelLegacy.h"
+#include "IndirectFittingModel.h"
namespace MantidQt {
namespace CustomInterfaces {
@@ -20,37 +20,37 @@ struct JumpFitParameters {
std::vector<std::size_t> eisfSpectra;
};
-class DLLExport JumpFitModel : public IndirectFittingModelLegacy {
+class DLLExport JumpFitModel : public IndirectFittingModel {
public:
- using IndirectFittingModelLegacy::addWorkspace;
+ using IndirectFittingModel::addWorkspace;
void addWorkspace(Mantid::API::MatrixWorkspace_sptr workspace,
- const SpectraLegacy & /*spectra*/) override;
- void removeWorkspace(std::size_t index) override;
+ const Spectra & /*spectra*/) override;
+ void removeWorkspace(TableDatasetIndex index) override;
void setFitType(const std::string &fitType);
- bool zeroWidths(std::size_t dataIndex) const;
- bool zeroEISF(std::size_t dataIndex) const;
+ bool zeroWidths(TableDatasetIndex dataIndex) const;
+ bool zeroEISF(TableDatasetIndex dataIndex) const;
bool isMultiFit() const override;
std::vector<std::string> getSpectrumDependentAttributes() const override;
- std::string getFitParameterName(std::size_t dataIndex,
- std::size_t spectrum) const;
- std::vector<std::string> getWidths(std::size_t dataIndex) const;
- std::vector<std::string> getEISF(std::size_t dataIndex) const;
- boost::optional<std::size_t> getWidthSpectrum(std::size_t widthIndex,
- std::size_t dataIndex) const;
- boost::optional<std::size_t> getEISFSpectrum(std::size_t eisfIndex,
- std::size_t dataIndex) const;
- void setActiveWidth(std::size_t widthIndex, std::size_t dataIndex);
- void setActiveEISF(std::size_t eisfIndex, std::size_t dataIndex);
+ std::string getFitParameterName(TableDatasetIndex dataIndex,
+ WorkspaceIndex spectrum) const;
+ std::vector<std::string> getWidths(TableDatasetIndex dataIndex) const;
+ std::vector<std::string> getEISF(TableDatasetIndex dataIndex) const;
+ boost::optional<std::size_t>
+ getWidthSpectrum(std::size_t widthIndex, TableDatasetIndex dataIndex) const;
+ boost::optional<std::size_t>
+ getEISFSpectrum(std::size_t eisfIndex, TableDatasetIndex dataIndex) const;
+ void setActiveWidth(std::size_t widthIndex, TableDatasetIndex dataIndex);
+ void setActiveEISF(std::size_t eisfIndex, TableDatasetIndex dataIndex);
std::string sequentialFitOutputName() const override;
std::string simultaneousFitOutputName() const override;
- std::string singleFitOutputName(std::size_t index,
- std::size_t spectrum) const override;
+ std::string singleFitOutputName(TableDatasetIndex index,
+ WorkspaceIndex spectrum) const override;
private:
std::string constructOutputName() const;
@@ -59,7 +59,7 @@ private:
addJumpFitParameters(Mantid::API::MatrixWorkspace *workspace,
const std::string &hwhmName);
std::unordered_map<std::string, JumpFitParameters>::const_iterator
- findJumpFitParameters(std::size_t dataIndex) const;
+ findJumpFitParameters(TableDatasetIndex dataIndex) const;
std::string getResultXAxisUnit() const override;
std::string getResultLogName() const override;
diff --git a/qt/scientific_interfaces/Indirect/MSDFit.cpp b/qt/scientific_interfaces/Indirect/MSDFit.cpp
index f2a7bd237d0cd25918ef4c29b386adbd9a6d107a..6d902dc22f9af8d0f5c3eef992c2636ef8f736fd 100644
--- a/qt/scientific_interfaces/Indirect/MSDFit.cpp
+++ b/qt/scientific_interfaces/Indirect/MSDFit.cpp
@@ -5,6 +5,8 @@
// & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
#include "MSDFit.h"
+#include "IndirectFunctionBrowser/MSDTemplateBrowser.h"
+
#include "MantidQtWidgets/Common/UserInputValidator.h"
#include "MantidAPI/AnalysisDataService.h"
@@ -26,19 +28,22 @@ namespace MantidQt {
namespace CustomInterfaces {
namespace IDA {
MSDFit::MSDFit(QWidget *parent)
- : IndirectFitAnalysisTabLegacy(new MSDFitModel, parent),
+ : IndirectFitAnalysisTab(new MSDFitModel, parent),
m_uiForm(new Ui::MSDFit) {
m_uiForm->setupUi(parent);
m_msdFittingModel = dynamic_cast<MSDFitModel *>(fittingModel());
- setFitDataPresenter(std::make_unique<IndirectFitDataPresenterLegacy>(
+ setFitDataPresenter(std::make_unique<IndirectFitDataPresenter>(
m_msdFittingModel, m_uiForm->fitDataView));
setPlotView(m_uiForm->pvFitPlotView);
setSpectrumSelectionView(m_uiForm->svSpectrumView);
setOutputOptionsView(m_uiForm->ovOutputOptionsView);
+ auto templateBrowser = new MSDTemplateBrowser;
+ m_uiForm->fitPropertyBrowser->setFunctionTemplateBrowser(templateBrowser);
setFitPropertyBrowser(m_uiForm->fitPropertyBrowser);
setEditResultVisible(false);
+ m_uiForm->fitDataView->setStartAndEndHidden(false);
}
void MSDFit::setupFitTab() {
@@ -46,17 +51,8 @@ void MSDFit::setupFitTab() {
auto gaussian = functionFactory.createFunction("MSDGauss");
auto peters = functionFactory.createFunction("MSDPeters");
auto yi = functionFactory.createFunction("MSDYi");
- addComboBoxFunctionGroup("Gaussian", {gaussian});
- addComboBoxFunctionGroup("Peters", {peters});
- addComboBoxFunctionGroup("Yi", {yi});
connect(m_uiForm->pbRun, SIGNAL(clicked()), this, SLOT(runClicked()));
- connect(this, SIGNAL(functionChanged()), this,
- SLOT(updateModelFitTypeString()));
-}
-
-void MSDFit::updateModelFitTypeString() {
- m_msdFittingModel->setFitType(selectedFitType().toStdString());
}
void MSDFit::runClicked() { runTab(); }
@@ -67,6 +63,13 @@ void MSDFit::setRunIsRunning(bool running) {
void MSDFit::setRunEnabled(bool enable) { m_uiForm->pbRun->setEnabled(enable); }
+EstimationDataSelector MSDFit::getEstimationDataSelector() const {
+ return [](const std::vector<double> &,
+ const std::vector<double> &) -> DataForParameterEstimation {
+ return DataForParameterEstimation{};
+ };
+}
+
} // namespace IDA
} // namespace CustomInterfaces
} // namespace MantidQt
diff --git a/qt/scientific_interfaces/Indirect/MSDFit.h b/qt/scientific_interfaces/Indirect/MSDFit.h
index ccfafe9d22c00a3b51d6a1a17d3896d86497cac7..3d7342e07b2d6b5c033677e6eaacc6b70d39fcc6 100644
--- a/qt/scientific_interfaces/Indirect/MSDFit.h
+++ b/qt/scientific_interfaces/Indirect/MSDFit.h
@@ -7,7 +7,7 @@
#ifndef MANTIDQTCUSTOMINTERFACESIDA_MSDFIT_H_
#define MANTIDQTCUSTOMINTERFACESIDA_MSDFIT_H_
-#include "IndirectFitAnalysisTabLegacy.h"
+#include "IndirectFitAnalysisTab.h"
#include "MSDFitModel.h"
#include "ui_MSDFit.h"
@@ -16,7 +16,7 @@
namespace MantidQt {
namespace CustomInterfaces {
namespace IDA {
-class DLLExport MSDFit : public IndirectFitAnalysisTabLegacy {
+class DLLExport MSDFit : public IndirectFitAnalysisTab {
Q_OBJECT
public:
@@ -28,7 +28,6 @@ public:
protected slots:
void runClicked();
- void updateModelFitTypeString();
protected:
void setRunIsRunning(bool running) override;
@@ -36,7 +35,7 @@ protected:
private:
void setupFitTab() override;
-
+ EstimationDataSelector getEstimationDataSelector() const override;
MSDFitModel *m_msdFittingModel;
std::unique_ptr<Ui::MSDFit> m_uiForm;
};
diff --git a/qt/scientific_interfaces/Indirect/MSDFit.ui b/qt/scientific_interfaces/Indirect/MSDFit.ui
index efea5d9bd43bde9b3480488fb5071b1785536d5f..8573bed196c2375b19ffe81401af832e7d6dd651 100644
--- a/qt/scientific_interfaces/Indirect/MSDFit.ui
+++ b/qt/scientific_interfaces/Indirect/MSDFit.ui
@@ -22,7 +22,7 @@
<property name="childrenCollapsible">
<bool>false</bool>
</property>
- <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitDataViewLegacy" name="fitDataView" native="true"/>
+ <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitDataView" name="fitDataView" native="true"/>
<widget class="QWidget" name="layoutWidget">
<layout class="QVBoxLayout" name="verticalLayout">
<property name="spacing">
@@ -31,12 +31,12 @@
<item>
<layout class="QHBoxLayout" name="loPlotArea" stretch="1,1">
<item>
- <widget class="MantidQt::MantidWidgets::IndirectFitPropertyBrowserLegacy" name="fitPropertyBrowser">
+ <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitPropertyBrowser" name="fitPropertyBrowser">
<widget class="QWidget" name="dockWidgetContents"/>
</widget>
</item>
<item>
- <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitPlotViewLegacy" name="pvFitPlotView" native="true"/>
+ <widget class="MantidQt::CustomInterfaces::IDA::IndirectFitPlotView" name="pvFitPlotView" native="true"/>
</item>
</layout>
</item>
@@ -59,7 +59,7 @@
<number>0</number>
</property>
<item>
- <widget class="MantidQt::CustomInterfaces::IDA::IndirectSpectrumSelectionViewLegacy" name="svSpectrumView" native="true"/>
+ <widget class="MantidQt::CustomInterfaces::IDA::IndirectSpectrumSelectionView" name="svSpectrumView" native="true"/>
</item>
<item>
<widget class="QGroupBox" name="gbRun">
@@ -123,27 +123,27 @@
</widget>
<customwidgets>
<customwidget>
- <class>MantidQt::CustomInterfaces::IDA::IndirectSpectrumSelectionViewLegacy</class>
+ <class>MantidQt::CustomInterfaces::IDA::IndirectSpectrumSelectionView</class>
<extends>QWidget</extends>
- <header>IndirectSpectrumSelectionViewLegacy.h</header>
+ <header>IndirectSpectrumSelectionView.h</header>
<container>1</container>
</customwidget>
<customwidget>
- <class>MantidQt::MantidWidgets::IndirectFitPropertyBrowserLegacy</class>
+ <class>MantidQt::CustomInterfaces::IDA::IndirectFitPropertyBrowser</class>
<extends>QDockWidget</extends>
- <header>MantidQtWidgets/Common/IndirectFitPropertyBrowserLegacy.h</header>
+ <header>IndirectFitPropertyBrowser.h</header>
<container>1</container>
</customwidget>
<customwidget>
- <class>MantidQt::CustomInterfaces::IDA::IndirectFitPlotViewLegacy</class>
+ <class>MantidQt::CustomInterfaces::IDA::IndirectFitPlotView</class>
<extends>QWidget</extends>
- <header>IndirectFitPlotViewLegacy.h</header>
+ <header>IndirectFitPlotView.h</header>
<container>1</container>
</customwidget>
<customwidget>
- <class>MantidQt::CustomInterfaces::IDA::IndirectFitDataViewLegacy</class>
+ <class>MantidQt::CustomInterfaces::IDA::IndirectFitDataView</class>
<extends>QWidget</extends>
- <header>IndirectFitDataViewLegacy.h</header>
+ <header>IndirectFitDataView.h</header>
<container>1</container>
</customwidget>
<customwidget>
diff --git a/qt/scientific_interfaces/Indirect/MSDFitModel.cpp b/qt/scientific_interfaces/Indirect/MSDFitModel.cpp
index 2e99654d688b321c1069dcf3234c02362a6eb84f..f39ba49b2a5273c3c621703c436b2858127eb756 100644
--- a/qt/scientific_interfaces/Indirect/MSDFitModel.cpp
+++ b/qt/scientific_interfaces/Indirect/MSDFitModel.cpp
@@ -12,24 +12,23 @@ namespace MantidQt {
namespace CustomInterfaces {
namespace IDA {
-void MSDFitModel::setFitType(const std::string &fitType) {
- m_fitType = fitType;
-}
-
std::string MSDFitModel::sequentialFitOutputName() const {
if (isMultiFit())
- return "MultiMSDFit_" + m_fitType + "_Results";
- return createOutputName("%1%_MSDFit_" + m_fitType + "_s%2%", "_to_", 0);
+ return "MultiMSDFit_" + fitModeToName[getFittingMode()] + "_Results";
+ return createOutputName("%1%_MSDFit_" + fitModeToName[getFittingMode()] +
+ "_s%2%",
+ "_to_", TableDatasetIndex{0});
}
std::string MSDFitModel::simultaneousFitOutputName() const {
return sequentialFitOutputName();
}
-std::string MSDFitModel::singleFitOutputName(std::size_t index,
- std::size_t spectrum) const {
- return createSingleFitOutputName("%1%_MSDFit_" + m_fitType + "_s%2%_Results",
- index, spectrum);
+std::string MSDFitModel::singleFitOutputName(TableDatasetIndex index,
+ WorkspaceIndex spectrum) const {
+ return createSingleFitOutputName(
+ "%1%_MSDFit_" + fitModeToName[getFittingMode()] + "_s%2%_Results", index,
+ spectrum);
}
std::vector<std::string> MSDFitModel::getSpectrumDependentAttributes() const {
diff --git a/qt/scientific_interfaces/Indirect/MSDFitModel.h b/qt/scientific_interfaces/Indirect/MSDFitModel.h
index a5270ff57ae269b8139e763993ecc778f3da5bb7..221cff23e52be4333a042aa490b829119c5ac2a5 100644
--- a/qt/scientific_interfaces/Indirect/MSDFitModel.h
+++ b/qt/scientific_interfaces/Indirect/MSDFitModel.h
@@ -7,27 +7,23 @@
#ifndef MANTIDQTCUSTOMINTERFACESIDA_MSDFITMODEL_H_
#define MANTIDQTCUSTOMINTERFACESIDA_MSDFITMODEL_H_
-#include "IndirectFittingModelLegacy.h"
+#include "IndirectFittingModel.h"
namespace MantidQt {
namespace CustomInterfaces {
namespace IDA {
-class DLLExport MSDFitModel : public IndirectFittingModelLegacy {
+class DLLExport MSDFitModel : public IndirectFittingModel {
public:
- void setFitType(const std::string &fitType);
-
std::string sequentialFitOutputName() const override;
std::string simultaneousFitOutputName() const override;
- std::string singleFitOutputName(std::size_t index,
- std::size_t spectrum) const override;
+ std::string singleFitOutputName(TableDatasetIndex index,
+ WorkspaceIndex spectrum) const override;
std::vector<std::string> getSpectrumDependentAttributes() const override;
private:
std::string getResultXAxisUnit() const override;
-
- std::string m_fitType;
};
} // namespace IDA
diff --git a/qt/scientific_interfaces/Indirect/Notifier.h b/qt/scientific_interfaces/Indirect/Notifier.h
new file mode 100644
index 0000000000000000000000000000000000000000..ab79a87f7bc0e54994313fd41dfa1a364af45159
--- /dev/null
+++ b/qt/scientific_interfaces/Indirect/Notifier.h
@@ -0,0 +1,23 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef MANTIDQTCUSTOMINTERFACES_NOTIFIER_H_
+#define MANTIDQTCUSTOMINTERFACES_NOTIFIER_H_
+
+template <class T> class Notifier {
+public:
+ void notify(const std::function<void(T &)> &fun) {
+ for (auto &subscriber : m_subscribers) {
+ fun(*subscriber);
+ }
+ };
+ void subscribe(T *observer) { m_subscribers.emplace_back(observer); };
+
+private:
+ std::vector<T *> m_subscribers;
+};
+
+#endif
diff --git a/qt/scientific_interfaces/Indirect/test/CMakeLists.txt b/qt/scientific_interfaces/Indirect/test/CMakeLists.txt
index 2b67482509b63fc6e7bc1daf2c9e58adf82c7a08..97d9f10a0417eb2e7cf6e63f2ebd89ecc4002741 100644
--- a/qt/scientific_interfaces/Indirect/test/CMakeLists.txt
+++ b/qt/scientific_interfaces/Indirect/test/CMakeLists.txt
@@ -24,7 +24,6 @@ set(
IqtFitModelTest.h
JumpFitDataPresenterTest.h
JumpFitModelTest.h
- MSDFitModelTest.h
)
mtd_add_qt_tests(
diff --git a/qt/scientific_interfaces/Indirect/test/JumpFitDataPresenterTest.h b/qt/scientific_interfaces/Indirect/test/JumpFitDataPresenterTest.h
index 2cdc68ace7dfad6b4211f7124404f24e00e56e49..906a509c21cc5af9ce610cdc53882986692686fe 100644
--- a/qt/scientific_interfaces/Indirect/test/JumpFitDataPresenterTest.h
+++ b/qt/scientific_interfaces/Indirect/test/JumpFitDataPresenterTest.h
@@ -10,7 +10,8 @@
#include <cxxtest/TestSuite.h>
#include <gmock/gmock.h>
-#include "IIndirectFitDataViewLegacy.h"
+#include "IIndirectFitDataView.h"
+#include "IndirectFunctionBrowser/FQTemplateBrowser.h"
#include "JumpFitDataPresenter.h"
#include "JumpFitModel.h"
@@ -70,7 +71,7 @@ std::unique_ptr<QTableWidget> createEmptyTableWidget(int columns, int rows) {
GNU_DIAG_OFF_SUGGEST_OVERRIDE
/// Mock object to mock the view
-class MockJumpFitDataView : public IIndirectFitDataViewLegacy {
+class MockJumpFitDataView : public IIndirectFitDataView {
public:
/// Public Methods
MOCK_CONST_METHOD0(getDataTable, QTableWidget *());
@@ -78,6 +79,9 @@ public:
MOCK_CONST_METHOD0(isResolutionHidden, bool());
MOCK_METHOD1(setResolutionHidden, void(bool hide));
MOCK_METHOD1(setStartAndEndHidden, void(bool hidden));
+ MOCK_METHOD1(setXRange, void(std::pair<double, double> const &range));
+ MOCK_METHOD1(setStartX, void(double startX));
+ MOCK_METHOD1(setEndX, void(double endX));
MOCK_METHOD0(disableMultipleDataTab, void());
MOCK_CONST_METHOD0(getSelectedSample, std::string());
@@ -104,6 +108,11 @@ public:
MOCK_METHOD1(displayWarning, void(std::string const &warning));
};
+class FQTemplateBrowserMock : public IFQFitObserver {
+ MOCK_METHOD1(updateDataType, void(DataType dataType));
+ MOCK_METHOD1(spectrumChanged, void(int spec));
+};
+
/// Mock object to mock the model
class MockJumpFitModel : public JumpFitModel {};
@@ -129,6 +138,7 @@ public:
m_ParameterCombo = createComboBox(getJumpParameters());
m_ParameterTypeLabel = createLabel(PARAMETER_TYPE_LABEL);
m_ParameterLabel = createLabel(PARAMETER_LABEL);
+ m_FQTemplateBrowser = std::make_unique<FQTemplateBrowserMock>();
ON_CALL(*m_view, getDataTable()).WillByDefault(Return(m_dataTable.get()));
@@ -137,7 +147,7 @@ public:
std::move(m_ParameterTypeCombo.get()),
std::move(m_ParameterCombo.get()),
std::move(m_ParameterTypeLabel.get()),
- std::move(m_ParameterLabel.get()));
+ std::move(m_ParameterLabel.get()), m_FQTemplateBrowser.get());
SetUpADSWithWorkspace m_ads(
"WorkspaceName", createWorkspaceWithTextAxis(6, getTextAxisLabels()));
@@ -188,7 +198,7 @@ public:
void
test_that_the_model_contains_the_correct_number_of_workspace_after_instantiation() {
- TS_ASSERT_EQUALS(m_model->numberOfWorkspaces(), 1);
+ TS_ASSERT_EQUALS(m_model->numberOfWorkspaces(), TableDatasetIndex{1});
}
///----------------------------------------------------------------------
@@ -201,6 +211,7 @@ private:
std::unique_ptr<QComboBox> m_ParameterCombo;
std::unique_ptr<QLabel> m_ParameterTypeLabel;
std::unique_ptr<QLabel> m_ParameterLabel;
+ std::unique_ptr<FQTemplateBrowserMock> m_FQTemplateBrowser;
std::unique_ptr<MockJumpFitDataView> m_view;
std::unique_ptr<MockJumpFitModel> m_model;
diff --git a/qt/scientific_interfaces/Indirect/test/JumpFitModelTest.h b/qt/scientific_interfaces/Indirect/test/JumpFitModelTest.h
index bcdceff6affaca6fd66416984f0f7600a05b88af..49add191ac8ac674f7d518b7a4bd486e460b1c6a 100644
--- a/qt/scientific_interfaces/Indirect/test/JumpFitModelTest.h
+++ b/qt/scientific_interfaces/Indirect/test/JumpFitModelTest.h
@@ -56,26 +56,26 @@ public:
}
void test_that_the_model_is_instantiated_and_can_hold_a_workspace() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- TS_ASSERT_EQUALS(m_model->numberOfWorkspaces(), 1);
+ TS_ASSERT_EQUALS(m_model->numberOfWorkspaces(), TableDatasetIndex{1});
}
void
test_that_removeWorkspace_will_remove_the_specified_workspace_from_the_model() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- m_model->removeWorkspace(0);
+ m_model->removeWorkspace(TableDatasetIndex{0});
- TS_ASSERT_EQUALS(m_model->numberOfWorkspaces(), 0);
+ TS_ASSERT_EQUALS(m_model->numberOfWorkspaces(), TableDatasetIndex{0});
}
void
test_that_setFitType_will_change_the_fit_type_in_the_sequentialFitOutputName() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
m_model->setFitType("ChudleyElliot");
@@ -86,7 +86,7 @@ public:
void
test_that_setFitType_will_change_the_fit_type_in_the_simultaneousFitOutputName() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
m_model->setFitType("ChudleyElliot");
@@ -96,44 +96,44 @@ public:
}
void test_that_zeroWidths_returns_false_if_the_workspace_contains_widths() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- TS_ASSERT(!m_model->zeroWidths(0));
+ TS_ASSERT(!m_model->zeroWidths(TableDatasetIndex{0}));
}
void test_that_zeroWidths_returns_true_if_the_workspace_contains_no_widths() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoWidthLabels());
m_ads->addOrReplace("Name2", workspace2);
addWorkspacesToModel(spectra, m_workspace, workspace2);
- TS_ASSERT(m_model->zeroWidths(1));
+ TS_ASSERT(m_model->zeroWidths(TableDatasetIndex{1}));
}
void test_that_zeroEISF_returns_false_if_the_workspace_contains_EISFs() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- TS_ASSERT(!m_model->zeroEISF(0));
+ TS_ASSERT(!m_model->zeroEISF(TableDatasetIndex{0}));
}
void test_that_zeroEISF_returns_true_if_the_workspace_contains_no_EISFs() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoEISFLabels());
m_ads->addOrReplace("Name2", workspace2);
addWorkspacesToModel(spectra, m_workspace, workspace2);
- TS_ASSERT(m_model->zeroEISF(1));
+ TS_ASSERT(m_model->zeroEISF(TableDatasetIndex{1}));
}
void
test_that_isMultiFit_returns_false_if_the_model_contains_one_workspace() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
@@ -142,7 +142,7 @@ public:
void
test_that_isMultiFit_returns_true_if_the_model_contains_multiple_workspace() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoEISFLabels());
m_ads->addOrReplace("Name2", workspace2);
@@ -153,7 +153,7 @@ public:
void
test_that_isMultiFit_returns_false_if_the_model_contains_multiple_workspace_which_are_identical() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace, m_workspace);
@@ -166,94 +166,104 @@ public:
void
test_that_getFitParameterName_will_return_the_name_of_the_expected_parameter() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- TS_ASSERT_EQUALS(m_model->getFitParameterName(0, 0), "f0.EISF");
- TS_ASSERT_EQUALS(m_model->getFitParameterName(0, 2), "f1.FWHM");
+ TS_ASSERT_EQUALS(m_model->getFitParameterName(
+ TableDatasetIndex{0},
+ MantidQt::CustomInterfaces::IDA::WorkspaceIndex{0}),
+ "f0.EISF");
+ TS_ASSERT_EQUALS(m_model->getFitParameterName(
+ TableDatasetIndex{0},
+ MantidQt::CustomInterfaces::IDA::WorkspaceIndex{2}),
+ "f1.FWHM");
}
void
test_that_getWidths_will_return_an_empty_vector_if_there_are_no_widths() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoWidthLabels());
m_ads->addOrReplace("Name2", workspace2);
addWorkspacesToModel(spectra, m_workspace, workspace2);
- TS_ASSERT(m_model->getWidths(1).empty());
+ TS_ASSERT(m_model->getWidths(TableDatasetIndex{1}).empty());
}
void test_that_getWidths_will_return_the_width_parameter_names() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- TS_ASSERT_EQUALS(m_model->getWidths(0)[0], "f1.Width");
- TS_ASSERT_EQUALS(m_model->getWidths(0)[1], "f1.FWHM");
+ TS_ASSERT_EQUALS(m_model->getWidths(TableDatasetIndex{0})[0], "f1.Width");
+ TS_ASSERT_EQUALS(m_model->getWidths(TableDatasetIndex{0})[1], "f1.FWHM");
}
void test_that_getEISF_will_return_an_empty_vector_if_there_are_no_EISFs() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoEISFLabels());
m_ads->addOrReplace("Name2", workspace2);
addWorkspacesToModel(spectra, m_workspace, workspace2);
- TS_ASSERT(m_model->getEISF(1).empty());
+ TS_ASSERT(m_model->getEISF(TableDatasetIndex{1}).empty());
}
void test_that_getEISF_will_return_the_EISF_parameter_names() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- TS_ASSERT_EQUALS(m_model->getEISF(0)[0], "f0.EISF");
- TS_ASSERT_EQUALS(m_model->getEISF(0)[1], "f1.EISF");
+ TS_ASSERT_EQUALS(m_model->getEISF(TableDatasetIndex{0})[0], "f0.EISF");
+ TS_ASSERT_EQUALS(m_model->getEISF(TableDatasetIndex{0})[1], "f1.EISF");
}
void test_that_getWidthSpectrum_will_return_none_when_there_are_no_widths() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoWidthLabels());
m_ads->addOrReplace("Name2", workspace2);
addWorkspacesToModel(spectra, m_workspace, workspace2);
- TS_ASSERT(!m_model->getWidthSpectrum(0, 1));
+ TS_ASSERT(!m_model->getWidthSpectrum(0, TableDatasetIndex{1}));
}
void test_that_getWidthSpectrum_will_return_the_width_spectrum_number() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- TS_ASSERT_EQUALS(m_model->getWidthSpectrum(0, 0).get(), 1);
- TS_ASSERT_EQUALS(m_model->getWidthSpectrum(1, 0).get(), 2);
+ TS_ASSERT_EQUALS(m_model->getWidthSpectrum(0, TableDatasetIndex{0}).get(),
+ 1);
+ TS_ASSERT_EQUALS(m_model->getWidthSpectrum(1, TableDatasetIndex{0}).get(),
+ 2);
}
void test_that_getEISFSpectrum_will_return_none_when_there_are_no_EISFs() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoEISFLabels());
m_ads->addOrReplace("Name2", workspace2);
addWorkspacesToModel(spectra, m_workspace, workspace2);
- TS_ASSERT(!m_model->getEISFSpectrum(0, 1));
+ TS_ASSERT(!m_model->getEISFSpectrum(0, TableDatasetIndex{1}));
}
void test_that_getEISFSpectrum_will_return_the_EISF_spectrum_number() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
- TS_ASSERT_EQUALS(m_model->getEISFSpectrum(0, 0).get(), 0);
- TS_ASSERT_EQUALS(m_model->getEISFSpectrum(1, 0).get(), 3);
+ TS_ASSERT_EQUALS(m_model->getEISFSpectrum(0, TableDatasetIndex{0}).get(),
+ 0);
+ TS_ASSERT_EQUALS(m_model->getEISFSpectrum(1, TableDatasetIndex{0}).get(),
+ 3);
}
void
test_that_sequentialFitOutputName_returns_the_correct_name_for_a_multi_fit() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoEISFLabels());
m_ads->addOrReplace("Name2", workspace2);
@@ -266,7 +276,7 @@ public:
void
test_that_simultaneousFitOutputName_returns_the_correct_name_for_a_multi_fit() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
auto const workspace2 = createWorkspaceWithTextAxis(2, getNoEISFLabels());
m_ads->addOrReplace("Name2", workspace2);
@@ -279,25 +289,26 @@ public:
void
test_that_singleFitOutputName_returns_the_correct_name_for_a_single_data_set_fit() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
+ Spectra const spectra = Spectra("0-1");
addWorkspacesToModel(spectra, m_workspace);
m_model->setFitType("ChudleyElliot");
- TS_ASSERT_EQUALS(m_model->singleFitOutputName(0, 0),
+ TS_ASSERT_EQUALS(m_model->singleFitOutputName(
+ TableDatasetIndex{0},
+ MantidQt::CustomInterfaces::IDA::WorkspaceIndex{0}),
"Name_HWHM_FofQFit_ChudleyElliot_s0_Results");
}
private:
template <typename Workspace, typename... Workspaces>
- void addWorkspacesToModel(SpectraLegacy const &spectra,
- Workspace const &workspace,
+ void addWorkspacesToModel(Spectra const &spectra, Workspace const &workspace,
Workspaces const &... workspaces) {
m_model->addWorkspace(workspace, spectra);
addWorkspacesToModel(spectra, workspaces...);
}
- void addWorkspacesToModel(SpectraLegacy const &spectra,
+ void addWorkspacesToModel(Spectra const &spectra,
MatrixWorkspace_sptr const &workspace) {
m_model->addWorkspace(workspace, spectra);
}
diff --git a/qt/scientific_interfaces/Indirect/test/MSDFitModelTest.h b/qt/scientific_interfaces/Indirect/test/MSDFitModelTest.h
deleted file mode 100644
index 97d52a9b0c3f24815086569b5f4d36ffa625086a..0000000000000000000000000000000000000000
--- a/qt/scientific_interfaces/Indirect/test/MSDFitModelTest.h
+++ /dev/null
@@ -1,94 +0,0 @@
-// Mantid Repository : https://github.com/mantidproject/mantid
-//
-// Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
-// NScD Oak Ridge National Laboratory, European Spallation Source
-// & Institut Laue - Langevin
-// SPDX - License - Identifier: GPL - 3.0 +
-#ifndef MANTIDQT_MSDFITMODELTEST_H_
-#define MANTIDQT_MSDFITMODELTEST_H_
-
-#include <cxxtest/TestSuite.h>
-
-#include "MSDFitModel.h"
-
-#include "MantidAPI/AnalysisDataService.h"
-#include "MantidAPI/FrameworkManager.h"
-#include "MantidAPI/MatrixWorkspace_fwd.h"
-#include "MantidTestHelpers/IndirectFitDataCreationHelper.h"
-
-using namespace Mantid::API;
-using namespace Mantid::IndirectFitDataCreationHelper;
-using namespace MantidQt::CustomInterfaces::IDA;
-
-class MSDFitModelTest : public CxxTest::TestSuite {
-public:
- /// WorkflowAlgorithms do not appear in the FrameworkManager without this line
- MSDFitModelTest() { FrameworkManager::Instance(); }
-
- static MSDFitModelTest *createSuite() { return new MSDFitModelTest(); }
-
- static void destroySuite(MSDFitModelTest *suite) { delete suite; }
-
- void setUp() override {
- m_workspace = createWorkspace(4, 3);
- m_ads = std::make_unique<SetUpADSWithWorkspace>("Name", m_workspace);
- m_model = std::make_unique<MSDFitModel>();
- }
-
- void tearDown() override {
- AnalysisDataService::Instance().clear();
-
- m_ads.reset();
- m_workspace.reset();
- m_model.reset();
- }
-
- void test_that_the_model_is_instantiated_and_can_hold_a_workspace() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
-
- m_model->addWorkspace(m_workspace, spectra);
-
- TS_ASSERT_EQUALS(m_model->numberOfWorkspaces(), 1);
- }
-
- void
- test_that_sequentialFitOutputName_returns_the_correct_name_which_uses_the_fit_string_set() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
-
- m_model->addWorkspace(m_workspace, spectra);
- m_model->setFitType("Gaussian");
- TS_ASSERT_EQUALS(m_model->sequentialFitOutputName(),
- "Name_MSDFit_Gaussian_s0-1_Results");
- }
-
- void
- test_that_simultaneousFitOutputName_returns_the_correct_name_which_uses_the_fit_string_set() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
-
- m_model->addWorkspace(m_workspace, spectra);
- m_model->setFitType("Gaussian");
- TS_ASSERT_EQUALS(m_model->simultaneousFitOutputName(),
- "Name_MSDFit_Gaussian_s0-1_Results");
- }
-
- void
- test_that_singleFitOutputName_returns_the_correct_name_which_uses_the_fit_string_set() {
- SpectraLegacy const spectra = DiscontinuousSpectra<std::size_t>("0-1");
-
- m_model->addWorkspace(m_workspace, spectra);
- m_model->setFitType("Gaussian");
- TS_ASSERT_EQUALS(m_model->singleFitOutputName(0, 0),
- "Name_MSDFit_Gaussian_s0_Results");
- }
-
- void test_that_getSpectrumDependentAttributes_returns_an_empty_vector() {
- TS_ASSERT(m_model->getSpectrumDependentAttributes().empty());
- }
-
-private:
- MatrixWorkspace_sptr m_workspace;
- std::unique_ptr<SetUpADSWithWorkspace> m_ads;
- std::unique_ptr<MSDFitModel> m_model;
-};
-
-#endif /* MANTIDQT_MSDFITMODELTEST_H_ */
diff --git a/qt/scientific_interfaces/test/ISISReflectometry/Common/DecoderTest.h b/qt/scientific_interfaces/test/ISISReflectometry/Common/DecoderTest.h
index a35b7d10c6a00a637f65e5a2df4ba90878defe7c..a9e6ec8193db7ca1e553454f7c0131fb18ee3775 100644
--- a/qt/scientific_interfaces/test/ISISReflectometry/Common/DecoderTest.h
+++ b/qt/scientific_interfaces/test/ISISReflectometry/Common/DecoderTest.h
@@ -11,7 +11,7 @@
#include "../../../ISISReflectometry/GUI/Common/Decoder.h"
#include "../ReflMockObjects.h"
#include "CoderCommonTester.h"
-#include "MantidAPI/FrameworkManager.h"
+#include "MantidPythonInterface/core/WrapPython.h"
#include "MantidQtWidgets/Common/QtJSONUtils.h"
#include <cxxtest/TestSuite.h>
@@ -168,7 +168,10 @@ public:
static DecoderTest *createSuite() { return new DecoderTest(); }
static void destroySuite(DecoderTest *suite) { delete suite; }
- void setUp() override { Mantid::API::FrameworkManager::Instance(); }
+ DecoderTest() {
+ PyRun_SimpleString("import mantid.api as api\n"
+ "api.FrameworkManager.Instance()");
+ }
void test_decode() {
CoderCommonTester tester;
diff --git a/qt/scientific_interfaces/test/ISISReflectometry/Common/EncoderTest.h b/qt/scientific_interfaces/test/ISISReflectometry/Common/EncoderTest.h
index 7dde60c8ebdd19172024bf3d82d605faa4b60ad6..d22a4f438a6e4ecf8fd44ad07c4942f2b18e4712 100644
--- a/qt/scientific_interfaces/test/ISISReflectometry/Common/EncoderTest.h
+++ b/qt/scientific_interfaces/test/ISISReflectometry/Common/EncoderTest.h
@@ -11,7 +11,7 @@
#include "../../../ISISReflectometry/GUI/Common/Encoder.h"
#include "../ReflMockObjects.h"
#include "CoderCommonTester.h"
-#include "MantidAPI/FrameworkManager.h"
+#include "MantidPythonInterface/core/WrapPython.h"
#include <cxxtest/TestSuite.h>
@@ -27,7 +27,10 @@ public:
static EncoderTest *createSuite() { return new EncoderTest(); }
static void destroySuite(EncoderTest *suite) { delete suite; }
- void setUp() override { Mantid::API::FrameworkManager::Instance(); }
+ EncoderTest() {
+ PyRun_SimpleString("import mantid.api as api\n"
+ "api.FrameworkManager.Instance()");
+ }
void test_encoder() {
CoderCommonTester tester;
diff --git a/qt/scientific_interfaces/test/ISISReflectometry/Common/PlotterTestQt5.h b/qt/scientific_interfaces/test/ISISReflectometry/Common/PlotterTestQt5.h
index dcc859af199eac12ea4a54d795054ad715c04060..2824e2a01d783596901807b47a68a22aa96709ae 100644
--- a/qt/scientific_interfaces/test/ISISReflectometry/Common/PlotterTestQt5.h
+++ b/qt/scientific_interfaces/test/ISISReflectometry/Common/PlotterTestQt5.h
@@ -12,22 +12,6 @@
#include "MantidQtWidgets/Common/Python/Object.h"
#include <cxxtest/TestSuite.h>
-namespace {
-void setMatplotlibBackend() {
- // Setup python and mantid python
- Py_Initialize();
- const MantidQt::Widgets::Common::Python::Object siteModule{
- MantidQt::Widgets::Common::Python::NewRef(PyImport_ImportModule("site"))};
- siteModule.attr("addsitedir")(
- Mantid::Kernel::ConfigService::Instance().getPropertiesDir());
-
- // Set matplotlib backend
- auto mpl = MantidQt::Widgets::Common::Python::NewRef(
- PyImport_ImportModule("matplotlib"));
- mpl.attr("use")("Agg");
-}
-} // namespace
-
class PlotterTestQt5 : public CxxTest::TestSuite {
public:
// This pair of boilerplate methods prevent the suite being created statically
@@ -35,12 +19,7 @@ public:
static PlotterTestQt5 *createSuite() { return new PlotterTestQt5(); }
static void destroySuite(PlotterTestQt5 *suite) { delete suite; }
- void setUp() override {
- Mantid::API::FrameworkManager::Instance();
- setMatplotlibBackend();
- }
-
- void tearDown() override { Py_Finalize(); }
+ PlotterTestQt5() { Mantid::API::FrameworkManager::Instance(); }
void testReflectometryPlot() {
// Just test that it doesn't segfault when plotting as nothing is returned
diff --git a/qt/scientific_interfaces/test/ScientificInterfacesTestInitialization.h b/qt/scientific_interfaces/test/ScientificInterfacesTestInitialization.h
new file mode 100644
index 0000000000000000000000000000000000000000..24ef3d360ed231700fc75b003dbb70abbb61e87f
--- /dev/null
+++ b/qt/scientific_interfaces/test/ScientificInterfacesTestInitialization.h
@@ -0,0 +1,20 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef REFLMPLCPPTESTGLOBALINITIALIZATION_H
+#define REFLMPLCPPTESTGLOBALINITIALIZATION_H
+
+#include "MantidPythonInterface/core/Testing/PythonInterpreterGlobalFixture.h"
+
+//------------------------------------------------------------------------------
+// Static definitions
+//
+// We rely on cxxtest only including this file once so that the following
+// statements do not cause multiple-definition errors.
+//------------------------------------------------------------------------------
+static PythonInterpreterGlobalFixture PYTHON_INTERPRETER;
+
+#endif // REFLMPLCPPTESTGLOBALINITIALIZATION_H
diff --git a/qt/widgets/common/CMakeLists.txt b/qt/widgets/common/CMakeLists.txt
index aaae86ccc7e863b6b3156c580612057d5004a89b..bf98cb1c1c80499eeb41d66c5bb5bdbfc584386b 100644
--- a/qt/widgets/common/CMakeLists.txt
+++ b/qt/widgets/common/CMakeLists.txt
@@ -132,6 +132,7 @@ set(
src/QtPropertyBrowser/StringDialogEditor.cpp
src/QtPropertyBrowser/StringEditorFactory.cpp
src/QtPropertyBrowser/WorkspaceEditorFactory.cpp
+ src/Python/CodeExecution.cpp
src/Python/Sip.cpp
src/Python/QHashToDict.cpp
)
@@ -284,6 +285,7 @@ set(QT5_INC_FILES
inc/MantidQtWidgets/Common/WorkspacePresenter/WorkspaceProvider.h
inc/MantidQtWidgets/Common/WorkspacePresenter/WorkspaceProviderNotifiable.h
inc/MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressModel.h
+ inc/MantidQtWidgets/Common/Python/CodeExecution.h
inc/MantidQtWidgets/Common/Python/Sip.h
inc/MantidQtWidgets/Common/Python/Object.h
inc/MantidQtWidgets/Common/Python/QHashToDict.h)
@@ -440,7 +442,6 @@ set(
src/MuonFitDataSelector.cpp
src/MuonFitPropertyBrowser.cpp
src/MuonFunctionBrowser.cpp
- src/NotificationService.cpp
src/ProcessingAlgoWidget.cpp
src/ProgressableView.cpp
src/ProjectSavePresenter.cpp
@@ -553,7 +554,6 @@ set(
inc/MantidQtWidgets/Common/MuonFitDataSelector.h
inc/MantidQtWidgets/Common/MuonFitPropertyBrowser.h
inc/MantidQtWidgets/Common/MuonFunctionBrowser.h
- inc/MantidQtWidgets/Common/NotificationService.h
inc/MantidQtWidgets/Common/pqHelpWindow.h
inc/MantidQtWidgets/Common/PropertyHandler.h
inc/MantidQtWidgets/Common/ProcessingAlgoWidget.h
@@ -905,6 +905,7 @@ mtd_add_qt_library(
SYSTEM_INCLUDE_DIRS ${Boost_INCLUDE_DIRS}
LINK_LIBS
${TARGET_LIBRARIES}
+ PythonInterfaceCore
${Boost_LIBRARIES}
${PYTHON_LIBRARIES}
QT5_LINK_LIBS
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressPresenter.h b/qt/widgets/common/inc/MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressPresenter.h
index 6f4fa512d5a2da740e2a347041c055b6d9cfc6fb..33251176641caaf40737b41c60e5bd361135dc06 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressPresenter.h
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressPresenter.h
@@ -7,6 +7,7 @@
#ifndef ALGORITHMPROGRESSPRESENTER_H
#define ALGORITHMPROGRESSPRESENTER_H
+#include "MantidKernel/Timer.h"
#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressModel.h"
#include "MantidQtWidgets/Common/AlgorithmProgress/AlgorithmProgressPresenterBase.h"
#include "MantidQtWidgets/Common/AlgorithmProgress/IAlgorithmProgressWidget.h"
@@ -55,6 +56,8 @@ private:
/// The view that contains the progress widget.
/// The creator of the view also owns the view (Python), not this presenter.
IAlgorithmProgressWidget *m_view;
+ /// Atimer to meaure how long since the last progress report
+ Mantid::Kernel::Timer m_timer;
};
} // namespace MantidWidgets
} // namespace MantidQt
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/DataProcessorUI/ProcessingAlgorithm.h b/qt/widgets/common/inc/MantidQtWidgets/Common/DataProcessorUI/ProcessingAlgorithm.h
index ec9471fee4290be819c26739122c0f4c7457bf92..9d718e30360258a2a943dd6e611081bcfd26adb9 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/DataProcessorUI/ProcessingAlgorithm.h
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/DataProcessorUI/ProcessingAlgorithm.h
@@ -28,11 +28,12 @@ public:
// Constructor
ProcessingAlgorithm(QString name, std::vector<QString> prefix,
std::size_t postprocessedOutputPrefixIndex,
- std::set<QString> blacklist = std::set<QString>());
+ std::set<QString> blacklist = std::set<QString>(),
+ const int version = -1);
// Delegating constructor
ProcessingAlgorithm(QString name, QString const &prefix,
std::size_t postprocessedOutputPrefixIndex,
- QString const &blacklist = "");
+ QString const &blacklist = "", const int version = -1);
// Destructor
virtual ~ProcessingAlgorithm();
// The number of output properties
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/DataProcessorUI/ProcessingAlgorithmBase.h b/qt/widgets/common/inc/MantidQtWidgets/Common/DataProcessorUI/ProcessingAlgorithmBase.h
index 12bab644e243d63fcbe443310e4b367895e4fc5e..cc679f2a1a3bd0539ddc5bd4876a25872de5fb88 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/DataProcessorUI/ProcessingAlgorithmBase.h
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/DataProcessorUI/ProcessingAlgorithmBase.h
@@ -33,7 +33,8 @@ public:
// Constructor
ProcessingAlgorithmBase(
const QString &name,
- const std::set<QString> &blacklist = std::set<QString>());
+ const std::set<QString> &blacklist = std::set<QString>(),
+ const int version = -1);
// Destructor
~ProcessingAlgorithmBase();
@@ -59,6 +60,8 @@ private:
// The name of this algorithm
QString m_algName;
+ // The version of this algorithm
+ int m_version;
// The blacklist
std::set<QString> m_blacklist;
// Input ws properties
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/FunctionTreeView.h b/qt/widgets/common/inc/MantidQtWidgets/Common/FunctionTreeView.h
index 6b4e11f26cd0048fe3b72d753a0775e27558a1d8..2de491a18af66204d47dbe7e938948f93f83ba70 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/FunctionTreeView.h
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/FunctionTreeView.h
@@ -10,6 +10,7 @@
#include "DllOption.h"
#include "MantidAPI/IFunction.h"
+#include "MantidKernel/EmptyValues.h"
#include "MantidQtWidgets/Common/IFunctionView.h"
#include <QMap>
@@ -214,8 +215,9 @@ protected:
/// Check if a parameter property has a upper bound
bool hasUpperBound(QtProperty *prop) const;
/// Get a constraint string
- QString getConstraint(const QString ¶mName, const double &lowerBound,
- const double &upperBound) const;
+ QString getConstraint(const QString ¶mName,
+ const double &lowerBound = Mantid::EMPTY_DBL(),
+ const double &upperBound = Mantid::EMPTY_DBL()) const;
/// Get a pair of function index (eg f0.f2.) and constraint expression given a
/// parameter property
std::pair<QString, QString> getFunctionAndConstraint(QtProperty *prop) const;
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/Python/CodeExecution.h b/qt/widgets/common/inc/MantidQtWidgets/Common/Python/CodeExecution.h
new file mode 100644
index 0000000000000000000000000000000000000000..444795d16a8fe6e001b74538d0f31bced0b8f61f
--- /dev/null
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/Python/CodeExecution.h
@@ -0,0 +1,35 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#ifndef MANTIDQTWIDGETS_LINETRACKINGEXECUTOR_H
+#define MANTIDQTWIDGETS_LINETRACKINGEXECUTOR_H
+
+#include "MantidPythonInterface/core/WrapPython.h"
+#include "MantidQtWidgets/Common/DllOption.h"
+#include <QString>
+
+class ScriptEditor;
+
+namespace MantidQt::Widgets::Common::Python {
+
+/**
+ * The CodeExecution class support execution of arbitrary Python code
+ * with the option to install a trace handler to track lines executed and
+ * tell an editor to mark them appropriately.
+ */
+class EXPORT_OPT_MANTIDQT_COMMON CodeExecution {
+public:
+ CodeExecution(ScriptEditor *editor);
+ PyObject *execute(const QString &codeStr, const QString &filename, int flags,
+ PyObject *globals) const;
+
+private:
+ ScriptEditor *m_editor{nullptr};
+};
+
+} // namespace MantidQt::Widgets::Common::Python
+
+#endif // MANTIDQTWIDGETS_LINETRACKINGEXECUTOR_H
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/ScriptEditor.h b/qt/widgets/common/inc/MantidQtWidgets/Common/ScriptEditor.h
index 596f62d32e90fbee31ff966f9eafebf3908f3dce..79fc79ca0b82f6f0aaf84df7c8a5c03ff003e5ad 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/ScriptEditor.h
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/ScriptEditor.h
@@ -123,6 +123,8 @@ public slots:
void padMargin();
/// Set the marker state
void setMarkerState(bool enabled);
+ /// Update the progress marker potentially from a separate thread
+ void updateProgressMarkerFromThread(int lineno, bool error = false);
/// Update the progress marker
void updateProgressMarker(int lineno, bool error = false);
/// Mark the progress arrow as an error
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/SelectFunctionDialog.h b/qt/widgets/common/inc/MantidQtWidgets/Common/SelectFunctionDialog.h
index 9402b621ddb22e8a79d1f8233a4773d7a543ffe2..372ae7939d40afaa3c50400641917b804de69507 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/SelectFunctionDialog.h
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/SelectFunctionDialog.h
@@ -11,6 +11,7 @@
// Includes
//--------------------------------------------------
#include "DllOption.h"
+#include "MantidQtWidgets/Common/MantidDialog.h"
#include <QDialog>
#include <QTreeWidgetItem>
@@ -26,7 +27,8 @@ namespace MantidWidgets {
/**
* Select a function type out of a list of available ones.
*/
-class EXPORT_OPT_MANTIDQT_COMMON SelectFunctionDialog : public QDialog {
+class EXPORT_OPT_MANTIDQT_COMMON SelectFunctionDialog
+ : public API::MantidDialog {
Q_OBJECT
public:
@@ -57,6 +59,7 @@ private slots:
void functionDoubleClicked(QTreeWidgetItem *item);
void acceptFunction();
void rejectFunction();
+ void helpClicked() const;
};
} // namespace MantidWidgets
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/SelectFunctionDialog.ui b/qt/widgets/common/inc/MantidQtWidgets/Common/SelectFunctionDialog.ui
index 59f208a030218fadb3c2227b324177eef0aa4923..9bdbe02fa73c9ede452992c7d84a1a9d3da08728 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/SelectFunctionDialog.ui
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/SelectFunctionDialog.ui
@@ -55,14 +55,31 @@
</layout>
</item>
<item>
- <widget class="QDialogButtonBox" name="buttonBox">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="standardButtons">
- <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
- </property>
- </widget>
+ <layout class="QHBoxLayout" name="horizontalLayout">
+ <item>
+ <widget class="QPushButton" name="helpButton">
+ <property name="maximumSize">
+ <size>
+ <width>25</width>
+ <height>16777215</height>
+ </size>
+ </property>
+ <property name="text">
+ <string>?</string>
+ </property>
+ </widget>
+ </item>
+ <item>
+ <widget class="QDialogButtonBox" name="buttonBox">
+ <property name="orientation">
+ <enum>Qt::Horizontal</enum>
+ </property>
+ <property name="standardButtons">
+ <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+ </property>
+ </widget>
+ </item>
+ </layout>
</item>
</layout>
</widget>
diff --git a/qt/widgets/common/inc/MantidQtWidgets/Common/pqHelpWindow.h b/qt/widgets/common/inc/MantidQtWidgets/Common/pqHelpWindow.h
index 8710581c22c1d8baf9f748ea4b86b8b52153feca..0e48246248bb87258b4a23962c5fe2a6be2bf9f7 100644
--- a/qt/widgets/common/inc/MantidQtWidgets/Common/pqHelpWindow.h
+++ b/qt/widgets/common/inc/MantidQtWidgets/Common/pqHelpWindow.h
@@ -97,6 +97,9 @@ public slots:
/// Prints the current open page
virtual void printPage();
+ /// Check if the url is an existing page
+ bool isExistingPage(const QUrl &url);
+
signals:
/// fired to relay warning messages from the help system.
void helpWarnings(const QString & /*_t1*/);
diff --git a/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressDialogPresenter.cpp b/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressDialogPresenter.cpp
index d498a92180c78b92163a6537405075155ce0d3a4..7d83d957311ef06aafa8659519fed0302c2f5966 100644
--- a/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressDialogPresenter.cpp
+++ b/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressDialogPresenter.cpp
@@ -47,9 +47,11 @@ void AlgorithmProgressDialogPresenter::algorithmStartedSlot(
// original algorithm has already finished, before we got a shared pointer.
// This ensures that the tracking only looks after an algorithm that has not
// finished
- if (algInstance) {
- auto treeItem = m_view->addAlgorithm(algInstance);
- m_progressBars.insert(std::make_pair(alg, treeItem));
+ if (m_progressBars.find(alg) == m_progressBars.end()) {
+ if (algInstance) {
+ auto treeItem = m_view->addAlgorithm(algInstance);
+ m_progressBars.insert(std::make_pair(alg, treeItem));
+ }
}
}
/// This slot is triggered whenever an algorithm reports progress.
diff --git a/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressPresenter.cpp b/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressPresenter.cpp
index 263d7bcd3645ce293bc1a5e41557e95890cf16bb..bd8fe59c6974cae78a99f72123e04bab22f868ab 100644
--- a/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressPresenter.cpp
+++ b/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressPresenter.cpp
@@ -13,7 +13,7 @@ AlgorithmProgressPresenter::AlgorithmProgressPresenter(
QWidget *parent, IAlgorithmProgressWidget *view)
: AlgorithmProgressPresenterBase(parent), m_model{AlgorithmProgressModel(
this)},
- m_algorithm(nullptr), m_view(view) {}
+ m_algorithm(nullptr), m_view(view), m_timer() {}
void AlgorithmProgressPresenter::algorithmStartedSlot(
Mantid::API::AlgorithmID alg) {
@@ -49,7 +49,12 @@ void AlgorithmProgressPresenter::updateProgressBarSlot(
if (algorithm == this->m_algorithm) {
// this needs to be a call to the view
// so that it can be mocked out for testing
- m_view->updateProgress(progress, message);
+ constexpr float maxRefreshInterval{0.1f};
+ float timeInterval = m_timer.elapsed_no_reset();
+ if (timeInterval > maxRefreshInterval) {
+ m_timer.reset();
+ m_view->updateProgress(progress, message);
+ }
}
}
diff --git a/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressWidget.cpp b/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressWidget.cpp
index 690144d5359ad233be269f5bf2ca38637f5de1b1..839e4af9647b7b6546483909230ee9aa7d3a76b3 100644
--- a/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressWidget.cpp
+++ b/qt/widgets/common/src/AlgorithmProgress/AlgorithmProgressWidget.cpp
@@ -29,7 +29,10 @@ AlgorithmProgressWidget::AlgorithmProgressWidget(QWidget *parent)
&AlgorithmProgressWidget::showDetailsDialog);
}
-void AlgorithmProgressWidget::algorithmStarted() {}
+void AlgorithmProgressWidget::algorithmStarted() {
+ // remove the word idle as we are doing something now
+ m_progressBar->setFormat("Running ...");
+}
void AlgorithmProgressWidget::algorithmEnded() {
m_progressBar->setValue(0);
diff --git a/qt/widgets/common/src/DataProcessorUI/ProcessingAlgorithm.cpp b/qt/widgets/common/src/DataProcessorUI/ProcessingAlgorithm.cpp
index 79b623f7c656792722e1a82e1f752f1441252d85..2586f951c11d841d5b7412c1a21f92ccbbd5a48f 100644
--- a/qt/widgets/common/src/DataProcessorUI/ProcessingAlgorithm.cpp
+++ b/qt/widgets/common/src/DataProcessorUI/ProcessingAlgorithm.cpp
@@ -17,11 +17,14 @@ namespace DataProcessor {
* @param postprocessedOutputPrefixIndex The zero based index of the prefix for
* the workspace which should be postprocessed
* @param blacklist : The list of properties we do not want to show
+ * @param version : The version of the algorithm to use. Defaults to -1 to
+ * indicate the most recent version.
*/
ProcessingAlgorithm::ProcessingAlgorithm(
QString name, std::vector<QString> prefix,
- std::size_t postprocessedOutputPrefixIndex, std::set<QString> blacklist)
- : ProcessingAlgorithmBase(std::move(name), std::move(blacklist)),
+ std::size_t postprocessedOutputPrefixIndex, std::set<QString> blacklist,
+ const int version)
+ : ProcessingAlgorithmBase(std::move(name), std::move(blacklist), version),
m_postprocessedOutputPrefixIndex(postprocessedOutputPrefixIndex),
m_prefix(std::move(prefix)) {
@@ -56,13 +59,16 @@ ProcessingAlgorithm::ProcessingAlgorithm(
* @param postprocessedOutputPrefixIndex The zero based index of the prefix for
* the workspace which should be postprocessed
* @param blacklist : The list of properties we do not want to show, as a string
+ * @param version : The version of the algorithm to use. Defaults to -1 to
+ * indicate the most recent version.
*/
ProcessingAlgorithm::ProcessingAlgorithm(
QString name, QString const &prefix,
- std::size_t postprocessedOutputPrefixIndex, QString const &blacklist)
+ std::size_t postprocessedOutputPrefixIndex, QString const &blacklist,
+ const int version)
: ProcessingAlgorithm(std::move(name), convertStringToVector(prefix),
postprocessedOutputPrefixIndex,
- convertStringToSet(blacklist)) {}
+ convertStringToSet(blacklist), version) {}
/**
* Constructor
diff --git a/qt/widgets/common/src/DataProcessorUI/ProcessingAlgorithmBase.cpp b/qt/widgets/common/src/DataProcessorUI/ProcessingAlgorithmBase.cpp
index a286fda0162859a2c9e3596253d0973576a68e95..4bb934c4fb51af7a5aa9e82b46c79d39fe156d14 100644
--- a/qt/widgets/common/src/DataProcessorUI/ProcessingAlgorithmBase.cpp
+++ b/qt/widgets/common/src/DataProcessorUI/ProcessingAlgorithmBase.cpp
@@ -14,16 +14,17 @@ namespace DataProcessor {
/** Constructor */
ProcessingAlgorithmBase::ProcessingAlgorithmBase(
- const QString &name, const std::set<QString> &blacklist)
- : m_algName(name), m_blacklist(blacklist), m_inputWsProperties(),
- m_inputStrListProperties(), m_OutputWsProperties() {
+ const QString &name, const std::set<QString> &blacklist, const int version)
+ : m_algName(name), m_version(version), m_blacklist(blacklist),
+ m_inputWsProperties(), m_inputStrListProperties(),
+ m_OutputWsProperties() {
countWsProperties();
}
/** Default constructor (nothing to do) */
ProcessingAlgorithmBase::ProcessingAlgorithmBase()
- : m_algName(), m_blacklist(), m_inputWsProperties(),
+ : m_algName(), m_version(-1), m_blacklist(), m_inputWsProperties(),
m_inputStrListProperties(), m_OutputWsProperties() {}
/** Destructor */
@@ -33,7 +34,8 @@ ProcessingAlgorithmBase::~ProcessingAlgorithmBase() {}
void ProcessingAlgorithmBase::countWsProperties() {
Mantid::API::IAlgorithm_sptr alg =
- Mantid::API::AlgorithmManager::Instance().create(m_algName.toStdString());
+ Mantid::API::AlgorithmManager::Instance().create(m_algName.toStdString(),
+ m_version);
auto properties = alg->getProperties();
for (auto &prop : properties) {
diff --git a/qt/widgets/common/src/FitPropertyBrowser.cpp b/qt/widgets/common/src/FitPropertyBrowser.cpp
index 4c50a0663106e5a62cb3b11982ec994bef9baf1a..a3d4445581200184155f6a40f90327da633cae54 100644
--- a/qt/widgets/common/src/FitPropertyBrowser.cpp
+++ b/qt/widgets/common/src/FitPropertyBrowser.cpp
@@ -3387,7 +3387,7 @@ QStringList FitPropertyBrowser::getParameterNames() const {
void FitPropertyBrowser::functionHelp() {
PropertyHandler *handler = currentHandler();
if (handler) {
- MantidQt::API::HelpWindow::showFitFunction(this->nativeParentWidget(),
+ MantidQt::API::HelpWindow::showFitFunction(nullptr,
handler->ifun()->name());
}
}
diff --git a/qt/widgets/common/src/FunctionTreeView.cpp b/qt/widgets/common/src/FunctionTreeView.cpp
index 7acd8d7d46b253f3a113f4501877e32a32542dbb..81e090003d4c3f408bec00b39ef820fbac0c9923 100644
--- a/qt/widgets/common/src/FunctionTreeView.cpp
+++ b/qt/widgets/common/src/FunctionTreeView.cpp
@@ -983,8 +983,8 @@ FunctionTreeView::addConstraintProperties(QtProperty *prop,
auto const parts = splitConstraintString(constraint);
if (parts.first.isEmpty())
return QList<FunctionTreeView::AProperty>();
- double lowerBound = parts.second.first.toDouble();
- double upperBound = parts.second.second.toDouble();
+ auto lowerBound = parts.second.first;
+ auto upperBound = parts.second.second;
// add properties
QList<FunctionTreeView::AProperty> plist;
@@ -992,17 +992,21 @@ FunctionTreeView::addConstraintProperties(QtProperty *prop,
ac.paramProp = prop;
ac.lower = ac.upper = nullptr;
- auto apLower =
- addProperty(prop, m_constraintManager->addProperty("LowerBound"));
- plist << apLower;
- ac.lower = apLower.prop;
- m_constraintManager->setValue(ac.lower, lowerBound);
+ if (!lowerBound.isEmpty()) {
+ auto apLower =
+ addProperty(prop, m_constraintManager->addProperty("LowerBound"));
+ plist << apLower;
+ ac.lower = apLower.prop;
+ m_constraintManager->setValue(ac.lower, lowerBound.toDouble());
+ }
- auto apUpper =
- addProperty(prop, m_constraintManager->addProperty("UpperBound"));
- plist << apUpper;
- ac.upper = apUpper.prop;
- m_constraintManager->setValue(ac.upper, upperBound);
+ if (!upperBound.isEmpty()) {
+ auto apUpper =
+ addProperty(prop, m_constraintManager->addProperty("UpperBound"));
+ plist << apUpper;
+ ac.upper = apUpper.prop;
+ m_constraintManager->setValue(ac.upper, upperBound.toDouble());
+ }
if (ac.lower || ac.upper) {
m_constraints.insert(m_properties[prop].parent, ac);
@@ -1069,11 +1073,14 @@ bool FunctionTreeView::hasUpperBound(QtProperty *prop) const {
QString FunctionTreeView::getConstraint(const QString ¶mName,
const double &lowerBound,
const double &upperBound) const {
+
QString constraint;
+ if (lowerBound != Mantid::EMPTY_DBL())
+ constraint += QString::number(lowerBound) + "<";
- constraint += QString::number(lowerBound) + "<";
constraint += paramName;
- constraint += "<" + QString::number(upperBound);
+ if (upperBound != Mantid::EMPTY_DBL())
+ constraint += "<" + QString::number(upperBound);
return constraint;
}
@@ -1659,17 +1666,20 @@ void FunctionTreeView::removeConstraint() {
std::pair<QString, QString>
FunctionTreeView::getFunctionAndConstraint(QtProperty *prop) const {
auto const parName = getParameterName(prop);
- double lower, upper;
+ double lower = Mantid::EMPTY_DBL();
+ double upper = Mantid::EMPTY_DBL();
for (auto p : prop->subProperties()) {
if (p->propertyName() == "LowerBound")
lower = m_constraintManager->value(p);
if (p->propertyName() == "UpperBound")
upper = m_constraintManager->value(p);
}
-
- QString functionIndex, name;
- std::tie(functionIndex, name) = splitParameterName(parName);
- return std::make_pair(functionIndex, getConstraint(name, lower, upper));
+ if (lower != Mantid::EMPTY_DBL() || upper != Mantid::EMPTY_DBL()) {
+ QString functionIndex, name;
+ std::tie(functionIndex, name) = splitParameterName(parName);
+ return std::make_pair(functionIndex, getConstraint(name, lower, upper));
+ }
+ return std::make_pair("", "");
} // namespace MantidWidgets
/**
diff --git a/qt/widgets/common/src/MantidHelpWindow.cpp b/qt/widgets/common/src/MantidHelpWindow.cpp
index 2d70f7a2d91786c396693724d67d9ebee39e0349..2c451a8a13cb4c446f06d48162f862395a234dcd 100644
--- a/qt/widgets/common/src/MantidHelpWindow.cpp
+++ b/qt/widgets/common/src/MantidHelpWindow.cpp
@@ -289,11 +289,12 @@ void MantidHelpWindow::showConcept(const QString &name) {
void MantidHelpWindow::showFitFunction(const std::string &name) {
if (bool(g_helpWindow)) {
QString url(BASE_URL);
- url += "fitfunctions/";
- if (name.empty())
+ url += "fitting/fitfunctions/";
+ auto functionUrl = url + QString(name.c_str()) + ".html";
+ if (name.empty() || !g_helpWindow->isExistingPage(functionUrl))
url += "index.html";
else
- url += QString(name.c_str()) + ".html";
+ url = functionUrl;
this->showHelp(url);
} else // qt-assistant disabled
diff --git a/qt/widgets/common/src/MessageDisplay.cpp b/qt/widgets/common/src/MessageDisplay.cpp
index 65b6aede2461a2c4c6b39bb1aba3c51d0783a0e3..993684a75e9f028ece1e84d2c94e73b0cbb681d4 100644
--- a/qt/widgets/common/src/MessageDisplay.cpp
+++ b/qt/widgets/common/src/MessageDisplay.cpp
@@ -11,7 +11,9 @@
#include "MantidKernel/ConfigService.h"
#include "MantidKernel/Logger.h"
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
#include "MantidQtWidgets/Common/NotificationService.h"
+#endif
#include <QAction>
#include <QActionGroup>
@@ -240,11 +242,13 @@ void MessageDisplay::append(const Message &msg) {
moveCursorToEnd();
if (msg.priority() <= Message::Priority::PRIO_ERROR) {
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
NotificationService::showMessage(
- "Mantid Workbench",
+ parentWidget() ? parentWidget()->windowTitle() : "Mantid",
"Sorry, there was an error, please look at the message display for "
"details.",
NotificationService::MessageIcon::Critical);
+#endif
emit errorReceived(msg.text());
}
if (msg.priority() <= Message::Priority::PRIO_WARNING)
diff --git a/qt/widgets/common/src/NotificationService.cpp b/qt/widgets/common/src/NotificationService.cpp
index 3eaf4822fcf900e25351868ffd05d0f63d335987..7e6986aba3fb0b3b329c32f80837de10b5d1c813 100644
--- a/qt/widgets/common/src/NotificationService.cpp
+++ b/qt/widgets/common/src/NotificationService.cpp
@@ -27,7 +27,7 @@ void NotificationService::showMessage(const QString &title,
if (windowIcon.isNull()) {
try {
windowIcon = QIcon(":/images/MantidIcon.ico");
- } catch (std::exception) {
+ } catch (const std::exception &) {
// if we cannot use the embedded icon, use a blank one
windowIcon = QIcon(QPixmap(32, 32));
}
@@ -48,11 +48,11 @@ bool NotificationService::isEnabled() {
retVal = Mantid::Kernel::ConfigService::Instance()
.getValue<bool>(NOTIFICATIONS_ENABLED_KEY)
.get_value_or(true);
- } catch (Mantid::Kernel::Exception::FileError) {
+ } catch (const Mantid::Kernel::Exception::FileError &) {
// The Config Service could not find the properties file
// Disable notifications
retVal = false;
- } catch (Poco::ExistsException) {
+ } catch (const Poco::ExistsException &) {
// The Config Service could not find the properties file
// Disable notifications
retVal = false;
diff --git a/qt/widgets/common/src/Python/CodeExecution.cpp b/qt/widgets/common/src/Python/CodeExecution.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..ebd540a2736ad5f4c32f832595557e3d7cea0a92
--- /dev/null
+++ b/qt/widgets/common/src/Python/CodeExecution.cpp
@@ -0,0 +1,91 @@
+// Mantid Repository : https://github.com/mantidproject/mantid
+//
+// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+// NScD Oak Ridge National Laboratory, European Spallation Source
+// & Institut Laue - Langevin
+// SPDX - License - Identifier: GPL - 3.0 +
+#include "MantidQtWidgets/Common/Python/CodeExecution.h"
+#include "MantidPythonInterface/core/GlobalInterpreterLock.h"
+#include "MantidPythonInterface/core/VersionCompat.h"
+#include "MantidQtWidgets/Common/ScriptEditor.h"
+#include <QHash>
+#include <QString>
+#include <frameobject.h>
+
+using Mantid::PythonInterface::GlobalInterpreterLock;
+
+namespace {
+
+// Map co_filename objects from PyCodeObject to an editor object
+QHash<PyObject *, ScriptEditor *> EDITOR_LOOKUP;
+
+/**
+ * A callback, set using PyEval_SetTrace, that is called by Python
+ * to allow inspection into the current execution frame. It is currently
+ * used to emit the line number of the frame that is being executed.
+ * @param obj :: A reference to the object passed as the second argument
+ * of PyEval_SetTrace. Assumed nullptr and unused
+ * @param frame :: A reference to the current frame object
+ * @param event :: An integer defining the event type, see
+ * http://docs.python.org/c-api/init.html#profiling-and-tracing
+ * @param arg :: Meaning varies depending on event type, see
+ * http://docs.python.org/c-api/init.html#profiling-and-tracing
+ */
+int traceLineNumber(PyObject *obj, PyFrameObject *frame, int event,
+ PyObject *arg) {
+ Q_UNUSED(obj);
+ Q_UNUSED(arg);
+ if (event != PyTrace_LINE)
+ return 0;
+ auto iter = EDITOR_LOOKUP.constFind(frame->f_code->co_filename);
+ if (iter != EDITOR_LOOKUP.constEnd()) {
+ iter.value()->updateProgressMarkerFromThread(frame->f_lineno, false);
+ }
+ return 0;
+}
+} // namespace
+
+namespace MantidQt::Widgets::Common::Python {
+
+/**
+ * Construct a LineTrackingExecutor for a given editor
+ * @param editor A pointer to an editor. Can be nullptr. Disables progress
+ * tracking.
+ */
+CodeExecution::CodeExecution(ScriptEditor *editor) : m_editor(editor) {}
+
+/**
+ * Execute the code string from the given filename and return the result
+ * @param codeStr A string containing the source code
+ * @param filename A string containing the filename of the source code
+ * @param flags An OR-ed combination of compiler flags
+ * @param globals A dictionary containing the current globals mapping
+ */
+PyObject *CodeExecution::execute(const QString &codeStr,
+ const QString &filename, int flags,
+ PyObject *globals) const {
+ GlobalInterpreterLock gil;
+ PyCompilerFlags compileFlags;
+ compileFlags.cf_flags = flags;
+ auto compiledCode = Py_CompileStringFlags(codeStr.toUtf8().constData(),
+ filename.toUtf8().constData(),
+ Py_file_input, &compileFlags);
+ if (compiledCode) {
+ if (m_editor) {
+ const auto coFileObject = ((PyCodeObject *)compiledCode)->co_filename;
+ const auto posIter = EDITOR_LOOKUP.insert(coFileObject, m_editor);
+ PyEval_SetTrace((Py_tracefunc)&traceLineNumber, nullptr);
+ const auto result =
+ PyEval_EvalCode(CODE_OBJECT(compiledCode), globals, globals);
+ PyEval_SetTrace(nullptr, nullptr);
+ EDITOR_LOOKUP.erase(posIter);
+ return result;
+ } else {
+ return PyEval_EvalCode(CODE_OBJECT(compiledCode), globals, globals);
+ }
+ } else {
+ return nullptr;
+ }
+}
+
+} // namespace MantidQt::Widgets::Common::Python
diff --git a/qt/widgets/common/src/ScriptEditor.cpp b/qt/widgets/common/src/ScriptEditor.cpp
index ec4d0d18d5cf228a805e29fc38d8f485cbe4a9d2..2835ecaaeabe5cf7a89a5b26ddd1cc8196637fc1 100644
--- a/qt/widgets/common/src/ScriptEditor.cpp
+++ b/qt/widgets/common/src/ScriptEditor.cpp
@@ -29,6 +29,7 @@
#include <QSettings>
#include <QShortcut>
#include <QTextStream>
+#include <QThread>
// Qscintilla
#include <Qsci/qsciapis.h>
@@ -378,6 +379,23 @@ void ScriptEditor::setMarkerState(bool enabled) {
}
}
+/**
+ * Update the arrow marker to point to the correct line and colour it
+ * depending on the error state. If the call is from a thread other than the
+ * application thread then the call is reperformed on that thread
+ * @param lineno :: The line to place the marker at. A negative number will
+ * clear all markers
+ * @param error :: If true, the marker will turn red
+ */
+void ScriptEditor::updateProgressMarkerFromThread(int lineno, bool error) {
+ if (QThread::currentThread() != QApplication::instance()->thread()) {
+ QMetaObject::invokeMethod(this, "updateProgressMarker", Qt::AutoConnection,
+ Q_ARG(int, lineno), Q_ARG(bool, error));
+ } else {
+ updateProgressMarker(lineno, error);
+ }
+}
+
/**
* Update the arrow marker to point to the correct line and colour it
* depending on the error state
@@ -386,6 +404,7 @@ void ScriptEditor::setMarkerState(bool enabled) {
* @param error :: If true, the marker will turn red
*/
void ScriptEditor::updateProgressMarker(int lineno, bool error) {
+
m_currentExecLine = lineno;
if (error) {
setMarkerBackgroundColor(g_error_colour, m_progressArrowKey);
diff --git a/qt/widgets/common/src/SelectFunctionDialog.cpp b/qt/widgets/common/src/SelectFunctionDialog.cpp
index 53112a174a48b8b152b2a94ba698f76e32577832..c3da14b461815608a27dc82e21e5190ed77e0562 100644
--- a/qt/widgets/common/src/SelectFunctionDialog.cpp
+++ b/qt/widgets/common/src/SelectFunctionDialog.cpp
@@ -12,6 +12,7 @@
#include "MantidAPI/FunctionFactory.h"
#include "MantidAPI/IFunction.h"
+#include "MantidQtWidgets/Common/HelpWindow.h"
#include <boost/lexical_cast.hpp>
@@ -43,7 +44,7 @@ SelectFunctionDialog::SelectFunctionDialog(QWidget *parent)
*/
SelectFunctionDialog::SelectFunctionDialog(
QWidget *parent, const std::vector<std::string> &restrictions)
- : QDialog(parent), m_form(new Ui::SelectFunctionDialog) {
+ : MantidDialog(parent), m_form(new Ui::SelectFunctionDialog) {
setWindowModality(Qt::WindowModal);
setWindowIcon(QIcon(":/images/MantidIcon.ico"));
m_form->setupUi(this);
@@ -86,6 +87,8 @@ SelectFunctionDialog::SelectFunctionDialog(
connect(m_form->buttonBox, SIGNAL(rejected()), this, SLOT(rejectFunction()));
m_form->searchBox->setCurrentIndex(-1);
+
+ connect(m_form->helpButton, SIGNAL(clicked()), this, SLOT(helpClicked()));
}
/**
@@ -227,5 +230,14 @@ void SelectFunctionDialog::rejectFunction() {
reject();
}
+void SelectFunctionDialog::helpClicked() const {
+ auto function = getFunction();
+ if (!function.isEmpty()) {
+ MantidQt::API::HelpWindow::showFitFunction(nullptr, function.toStdString());
+ } else { // No function selected open fit function index
+ MantidQt::API::HelpWindow::showFitFunction(nullptr, "");
+ }
+}
+
} // namespace MantidWidgets
} // namespace MantidQt
diff --git a/qt/widgets/common/src/pqHelpWindow.cxx b/qt/widgets/common/src/pqHelpWindow.cxx
index 4a059fd33cfd63aaa47d098a1928f70b383a74f7..b462a60656f66f9b65433118a8b2de6fdbead190 100644
--- a/qt/widgets/common/src/pqHelpWindow.cxx
+++ b/qt/widgets/common/src/pqHelpWindow.cxx
@@ -428,3 +428,8 @@ void pqHelpWindow::showHomePage(const QString &namespace_name) {
}
errorMissingPage(QUrl("Could not locate index.html"));
}
+
+//-----------------------------------------------------------------------------
+bool pqHelpWindow::isExistingPage(const QUrl& url) {
+ return this->m_helpEngine->findFile(url).isValid();
+}
diff --git a/qt/widgets/common/test/DataProcessorUI/GenerateNotebookTest.h b/qt/widgets/common/test/DataProcessorUI/GenerateNotebookTest.h
index df5f169d2f806089778581f641df309cdb68bc19..1e2fcb495c28790e7cc5166d7f523f04a82032fa 100644
--- a/qt/widgets/common/test/DataProcessorUI/GenerateNotebookTest.h
+++ b/qt/widgets/common/test/DataProcessorUI/GenerateNotebookTest.h
@@ -54,7 +54,8 @@ private:
std::vector<QString>{"IvsQ_binned_", "IvsQ_", "IvsLam_"}, 1,
std::set<QString>{"ThetaIn", "ThetaOut", "InputWorkspace",
"OutputWorkspace", "OutputWorkspaceWavelength",
- "FirstTransmissionRun", "SecondTransmissionRun"});
+ "FirstTransmissionRun", "SecondTransmissionRun"},
+ 2);
}
PostprocessingAlgorithm reflPostprocessor() {
diff --git a/qt/widgets/common/test/DataProcessorUI/GenericDataProcessorPresenterTest.h b/qt/widgets/common/test/DataProcessorUI/GenericDataProcessorPresenterTest.h
index 88f0c4fd05adb009ccebd1222583fbabd093085f..492e633956910758e9998c6efb584242e4677794 100644
--- a/qt/widgets/common/test/DataProcessorUI/GenericDataProcessorPresenterTest.h
+++ b/qt/widgets/common/test/DataProcessorUI/GenericDataProcessorPresenterTest.h
@@ -175,7 +175,8 @@ private:
std::vector<QString>{"IvsQ_binned_", "IvsQ_", "IvsLam_"}, 1,
std::set<QString>{"ThetaIn", "ThetaOut", "InputWorkspace",
"OutputWorkspace", "OutputWorkspaceWavelength",
- "FirstTransmissionRun", "SecondTransmissionRun"});
+ "FirstTransmissionRun", "SecondTransmissionRun"},
+ 2);
}
PostprocessingAlgorithm createReflectometryPostprocessor() {
@@ -1680,8 +1681,8 @@ public:
AnalysisDataService::Instance().doesExist("IvsQ_binned_TOF_dataB"));
TS_ASSERT(AnalysisDataService::Instance().doesExist("IvsQ_TOF_dataA"));
TS_ASSERT(AnalysisDataService::Instance().doesExist("IvsQ_TOF_dataB"));
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("IvsLam_TOF_dataA"));
- TS_ASSERT(!AnalysisDataService::Instance().doesExist("IvsLam_TOF_dataB"));
+ TS_ASSERT(AnalysisDataService::Instance().doesExist("IvsLam_TOF_dataA"));
+ TS_ASSERT(AnalysisDataService::Instance().doesExist("IvsLam_TOF_dataB"));
TS_ASSERT(
AnalysisDataService::Instance().doesExist("IvsQ_TOF_dataA_TOF_dataB"));
diff --git a/qt/widgets/common/test/DataProcessorUI/ProcessingAlgorithmTest.h b/qt/widgets/common/test/DataProcessorUI/ProcessingAlgorithmTest.h
index 15e763876c3edb2b59c9b31dfcb7218fbf877c76..65abea4d28791c57746b9d8c28da85b052effbf4 100644
--- a/qt/widgets/common/test/DataProcessorUI/ProcessingAlgorithmTest.h
+++ b/qt/widgets/common/test/DataProcessorUI/ProcessingAlgorithmTest.h
@@ -68,21 +68,22 @@ public:
prefixes.emplace_back("IvsQ_");
// This should throw
TS_ASSERT_THROWS(
- ProcessingAlgorithm(algName, prefixes, 0, std::set<QString>()),
+ ProcessingAlgorithm(algName, prefixes, 0, std::set<QString>(), 2),
const std::invalid_argument &);
// This should also throw
TS_ASSERT_THROWS(
- ProcessingAlgorithm(algName, prefixes, 0, std::set<QString>()),
+ ProcessingAlgorithm(algName, prefixes, 0, std::set<QString>(), 2),
const std::invalid_argument &);
// But this should be OK
prefixes.emplace_back("IvsLam_");
TS_ASSERT_THROWS_NOTHING(
- ProcessingAlgorithm(algName, prefixes, 0, std::set<QString>()));
+ ProcessingAlgorithm(algName, prefixes, 0, std::set<QString>(), 2));
auto const postprocessedOutputPrefixIndex = 1;
- auto alg = ProcessingAlgorithm(
- algName, prefixes, postprocessedOutputPrefixIndex, std::set<QString>());
+ auto alg =
+ ProcessingAlgorithm(algName, prefixes, postprocessedOutputPrefixIndex,
+ std::set<QString>(), 2);
TS_ASSERT_EQUALS(alg.name(), "ReflectometryReductionOneAuto");
TS_ASSERT_EQUALS(alg.numberOfOutputProperties(), 3);
TS_ASSERT_EQUALS(alg.prefix(0), "IvsQ_binned_");
diff --git a/qt/widgets/instrumentview/inc/MantidQtWidgets/InstrumentView/InstrumentWidget.h b/qt/widgets/instrumentview/inc/MantidQtWidgets/InstrumentView/InstrumentWidget.h
index 632a3725c56b258954827fabb98d5670f0066aaf..918be2a96c71bcd279e14166fb411d9ba302db31 100644
--- a/qt/widgets/instrumentview/inc/MantidQtWidgets/InstrumentView/InstrumentWidget.h
+++ b/qt/widgets/instrumentview/inc/MantidQtWidgets/InstrumentView/InstrumentWidget.h
@@ -107,6 +107,8 @@ public:
Mantid::Kernel::V3D getSurfaceAxis(const int surfaceType) const;
/// Get pointer to the projection surface
boost::shared_ptr<ProjectionSurface> getSurface() const;
+ /// True if the workspace is being replaced
+ bool isWsBeingReplaced() const;
/// True if the GL instrument display is currently on
bool isGLEnabled() const;
/// Toggle between the GL and simple instrument display widgets
@@ -338,6 +340,7 @@ private:
/// Save tabs on the widget to a string
std::string saveTabs() const;
+ bool m_wsReplace;
QPushButton *m_help;
};
diff --git a/qt/widgets/instrumentview/src/InstrumentWidget.cpp b/qt/widgets/instrumentview/src/InstrumentWidget.cpp
index b73f90f72778327fc168d44cd9b9a6f1d5b031c1..43f392abe5903525f1fb75320d6a37256cda2e9b 100644
--- a/qt/widgets/instrumentview/src/InstrumentWidget.cpp
+++ b/qt/widgets/instrumentview/src/InstrumentWidget.cpp
@@ -72,6 +72,26 @@ using namespace MantidQt::API;
namespace MantidQt {
namespace MantidWidgets {
+namespace {
+/**
+ * An object to correctly set the flag marking workspace replacement
+ */
+struct WorkspaceReplacementFlagHolder {
+ /**
+ * @param :: reference to the workspace replacement flag
+ */
+ explicit WorkspaceReplacementFlagHolder(bool &replacementFlag)
+ : m_worskpaceReplacementFlag(replacementFlag) {
+ m_worskpaceReplacementFlag = true;
+ }
+ ~WorkspaceReplacementFlagHolder() { m_worskpaceReplacementFlag = false; }
+
+private:
+ WorkspaceReplacementFlagHolder();
+ bool &m_worskpaceReplacementFlag;
+};
+} // namespace
+
// Name of the QSettings group to store the InstrumentWindw settings
const char *InstrumentWidgetSettingsGroup = "Mantid/InstrumentWidget";
@@ -102,7 +122,7 @@ InstrumentWidget::InstrumentWidget(const QString &wsName, QWidget *parent,
mViewChanged(false), m_blocked(false),
m_instrumentDisplayContextMenuOn(false),
m_stateOfTabs(std::vector<std::pair<std::string, bool>>{}),
- m_help(nullptr) {
+ m_wsReplace(false), m_help(nullptr) {
setFocusPolicy(Qt::StrongFocus);
QVBoxLayout *mainLayout = new QVBoxLayout(this);
QSplitter *controlPanelLayout = new QSplitter(Qt::Horizontal);
@@ -1094,6 +1114,10 @@ ProjectionSurface_sptr InstrumentWidget::getSurface() const {
return ProjectionSurface_sptr();
}
+bool MantidQt::MantidWidgets::InstrumentWidget::isWsBeingReplaced() const {
+ return m_wsReplace;
+}
+
/**
* Set newly created projection surface
* @param surface :: Pointer to the new surace.
@@ -1314,33 +1338,24 @@ bool InstrumentWidget::hasWorkspace(const std::string &wsName) const {
void InstrumentWidget::handleWorkspaceReplacement(
const std::string &wsName, const boost::shared_ptr<Workspace> workspace) {
+ if (!hasWorkspace(wsName) || !m_instrumentActor) {
+ return;
+ }
// Replace current workspace
- if (hasWorkspace(wsName)) {
- if (m_instrumentActor) {
- // Check if it's still the same workspace underneath (as well as having
- // the same name)
- auto matrixWS =
- boost::dynamic_pointer_cast<const MatrixWorkspace>(workspace);
- if (!matrixWS || matrixWS->detectorInfo().size() == 0) {
- emit preDeletingHandle();
- close();
- return;
- }
- // try to detect if the instrument changes (unlikely if the workspace
- // hasn't, but theoretically possible)
- bool resetGeometry =
- matrixWS->detectorInfo().size() != m_instrumentActor->ndetectors();
- try {
- if (matrixWS == m_instrumentActor->getWorkspace() && !resetGeometry) {
- m_instrumentActor->updateColors();
- setupColorMap();
- updateInstrumentView();
- }
- } catch (std::runtime_error &) {
- resetInstrument(resetGeometry);
- }
- }
+ WorkspaceReplacementFlagHolder wsReplace(m_wsReplace);
+ // Check if it's still the same workspace underneath (as well as having
+ // the same name)
+ auto matrixWS = boost::dynamic_pointer_cast<const MatrixWorkspace>(workspace);
+ if (!matrixWS || matrixWS->detectorInfo().size() == 0) {
+ emit preDeletingHandle();
+ close();
+ return;
}
+ // try to detect if the instrument changes (unlikely if the workspace
+ // hasn't, but theoretically possible)
+ bool resetGeometry =
+ matrixWS->detectorInfo().size() != m_instrumentActor->ndetectors();
+ resetInstrument(resetGeometry);
}
/**
diff --git a/qt/widgets/instrumentview/src/InstrumentWidgetEncoder.cpp b/qt/widgets/instrumentview/src/InstrumentWidgetEncoder.cpp
index 63bfaf868f4e4dcb74aa552005bf7d7742161ef2..4ab6266c2dc2d2394c560c02fb8a144cd8058b53 100644
--- a/qt/widgets/instrumentview/src/InstrumentWidgetEncoder.cpp
+++ b/qt/widgets/instrumentview/src/InstrumentWidgetEncoder.cpp
@@ -37,26 +37,29 @@ InstrumentWidgetEncoder::encode(const InstrumentWidget &obj,
const QString &projectPath,
const bool saveMask) {
QMap<QString, QVariant> map;
- m_projectPath = projectPath.toStdString();
- m_saveMask = saveMask;
+ // there is no reference to the workspace if it is being replaced, so return
+ // the empty map
+ if (!obj.isWsBeingReplaced()) {
+ m_projectPath = projectPath.toStdString();
+ m_saveMask = saveMask;
- map.insert(QString("workspaceName"), QVariant(obj.getWorkspaceName()));
+ map.insert(QString("workspaceName"), QVariant(obj.getWorkspaceName()));
- map.insert(QString("surfaceType"), QVariant(obj.getSurfaceType()));
+ map.insert(QString("surfaceType"), QVariant(obj.getSurfaceType()));
- map.insert(QString("currentTab"), QVariant(obj.getCurrentTab()));
+ map.insert(QString("currentTab"), QVariant(obj.getCurrentTab()));
- QList<QVariant> energyTransferList;
- energyTransferList.append(QVariant(obj.m_xIntegration->getMinimum()));
- energyTransferList.append(QVariant(obj.m_xIntegration->getMaximum()));
- map.insert(QString("energyTransfer"), QVariant(energyTransferList));
-
- map.insert(QString("surface"),
- QVariant(this->encodeSurface(obj.getSurface())));
- map.insert(QString("actor"),
- QVariant(this->encodeActor(obj.m_instrumentActor)));
- map.insert(QString("tabs"), QVariant(this->encodeTabs(obj)));
+ QList<QVariant> energyTransferList;
+ energyTransferList.append(QVariant(obj.m_xIntegration->getMinimum()));
+ energyTransferList.append(QVariant(obj.m_xIntegration->getMaximum()));
+ map.insert(QString("energyTransfer"), QVariant(energyTransferList));
+ map.insert(QString("surface"),
+ QVariant(this->encodeSurface(obj.getSurface())));
+ map.insert(QString("actor"),
+ QVariant(this->encodeActor(obj.m_instrumentActor)));
+ map.insert(QString("tabs"), QVariant(this->encodeTabs(obj)));
+ }
return map;
}
diff --git a/qt/widgets/instrumentview/src/InstrumentWidgetMaskTab.cpp b/qt/widgets/instrumentview/src/InstrumentWidgetMaskTab.cpp
index f10f35a20501489086608921682081a40e46ba24..452530535556b554ca08fa1884bb53ea3a6ccc74 100644
--- a/qt/widgets/instrumentview/src/InstrumentWidgetMaskTab.cpp
+++ b/qt/widgets/instrumentview/src/InstrumentWidgetMaskTab.cpp
@@ -1382,20 +1382,19 @@ bool InstrumentWidgetMaskTab::saveMaskViewToProject(
// get masked detector workspace from actor
const auto &actor = m_instrWidget->getInstrumentActor();
- auto outputWS = actor.getMaskMatrixWorkspace();
-
- if (!outputWS)
- return false; // no mask workspace was found
-
- // save mask to file inside project folder
- auto alg = AlgorithmManager::Instance().createUnmanaged("SaveMask", -1);
- alg->setChild(true);
- alg->setProperty("InputWorkspace",
- boost::dynamic_pointer_cast<Workspace>(outputWS));
- alg->setPropertyValue("OutputFile", fileName);
- alg->setLogging(false);
- alg->execute();
-
+ if (actor.hasMaskWorkspace()) {
+ auto outputWS = actor.getMaskMatrixWorkspace();
+ // save mask to file inside project folder
+ auto alg = AlgorithmManager::Instance().createUnmanaged("SaveMask", -1);
+ alg->setChild(true);
+ alg->setProperty("InputWorkspace",
+ boost::dynamic_pointer_cast<Workspace>(outputWS));
+ alg->setPropertyValue("OutputFile", fileName);
+ alg->setLogging(false);
+ alg->execute();
+ } else {
+ return false;
+ }
} catch (...) {
// just fail silently, if we can't save the mask then we should
// give up at this point.
diff --git a/scripts/AbinsModules/AbinsConstants.py b/scripts/AbinsModules/AbinsConstants.py
index dc5c6ad5dfda350e481af8d1cf0f2e8077640a9a..d0f0986b4ee5271aca030ff17896b2369473d845 100644
--- a/scripts/AbinsModules/AbinsConstants.py
+++ b/scripts/AbinsModules/AbinsConstants.py
@@ -174,7 +174,6 @@ MAX_WAVENUMBER = 5000.0 # in cm^-1
MAX_POINTS_PER_PEAK = 1000
MIN_POINTS_PER_PEAK = 1
-SMALL_S = 1e-6
MAX_THRESHOLD = 0.3
ONE_CHARACTER = 1
diff --git a/scripts/AbinsModules/IOmodule.py b/scripts/AbinsModules/IOmodule.py
index 0c6efa6693510c821ab0f5f39d200b10d7d041a0..1da54ef15fbde9c324356d0bf9bb320e795e3297 100644
--- a/scripts/AbinsModules/IOmodule.py
+++ b/scripts/AbinsModules/IOmodule.py
@@ -355,7 +355,7 @@ class IOmodule(object):
# noinspection PyUnresolvedReferences,PyProtectedMember
if isinstance(hdf_group, h5py._hl.dataset.Dataset):
- return hdf_group.value
+ return hdf_group[()]
elif all([self._get_subgrp_name(hdf_group[el].name).isdigit() for el in hdf_group.keys()]):
structured_dataset_list = []
# here we make an assumption about keys which have a numeric values; we assume that always : 1, 2, 3... Max
@@ -383,7 +383,7 @@ class IOmodule(object):
for key, item in hdf_file[path].items():
# noinspection PyUnresolvedReferences,PyProtectedMember,PyProtectedMember
if isinstance(item, h5py._hl.dataset.Dataset):
- ans[key] = item.value
+ ans[key] = item[()]
elif isinstance(item, h5py._hl.group.Group):
ans[key] = cls._recursively_load_dict_contents_from_group(hdf_file, path + key + '/')
return ans
diff --git a/scripts/AbinsModules/SData.py b/scripts/AbinsModules/SData.py
index 88fe53fa8249eead1f2a3df21ddafc5f849393d8..44ea39697b8656136c80785b17bf781c2dcf3db8 100644
--- a/scripts/AbinsModules/SData.py
+++ b/scripts/AbinsModules/SData.py
@@ -6,7 +6,9 @@
# SPDX - License - Identifier: GPL - 3.0 +
from __future__ import (absolute_import, division, print_function)
import numpy as np
+from mantid.kernel import logger as mantid_logger
import AbinsModules
+from AbinsModules import AbinsConstants, AbinsParameters
class SData(AbinsModules.GeneralData):
@@ -21,7 +23,7 @@ class SData(AbinsModules.GeneralData):
raise ValueError("Invalid value of temperature.")
self._temperature = float(temperature)
- if sample_form in AbinsModules.AbinsConstants.ALL_SAMPLE_FORMS:
+ if sample_form in AbinsConstants.ALL_SAMPLE_FORMS:
self._sample_form = sample_form
else:
raise ValueError("Invalid sample form %s" % sample_form)
@@ -40,24 +42,24 @@ class SData(AbinsModules.GeneralData):
raise ValueError("New value of S should have a form of a dict.")
for item in items:
- if AbinsModules.AbinsConstants.ATOM_LABEL in item:
+ if AbinsConstants.ATOM_LABEL in item:
if not isinstance(items[item], dict):
raise ValueError("New value of item from S data should have a form of dictionary.")
- if sorted(items[item].keys()) != sorted(AbinsModules.AbinsConstants.ALL_KEYWORDS_ATOMS_S_DATA):
+ if sorted(items[item].keys()) != sorted(AbinsConstants.ALL_KEYWORDS_ATOMS_S_DATA):
raise ValueError("Invalid structure of the dictionary.")
- for order in items[item][AbinsModules.AbinsConstants.S_LABEL]:
- if not isinstance(items[item][AbinsModules.AbinsConstants.S_LABEL][order], np.ndarray):
+ for order in items[item][AbinsConstants.S_LABEL]:
+ if not isinstance(items[item][AbinsConstants.S_LABEL][order], np.ndarray):
raise ValueError("Numpy array was expected.")
elif "frequencies" == item:
step = self._bin_width
- bins = np.arange(start=AbinsModules.AbinsParameters.sampling['min_wavenumber'],
- stop=AbinsModules.AbinsParameters.sampling['max_wavenumber'] + step,
+ bins = np.arange(start=AbinsParameters.sampling['min_wavenumber'],
+ stop=AbinsParameters.sampling['max_wavenumber'] + step,
step=step,
- dtype=AbinsModules.AbinsConstants.FLOAT_TYPE)
+ dtype=AbinsConstants.FLOAT_TYPE)
freq_points = bins[:-1] + (step / 2)
if not np.array_equal(items[item], freq_points):
@@ -75,5 +77,53 @@ class SData(AbinsModules.GeneralData):
"""
return self._data
+ def check_thresholds(self, return_cases=False, logger=None):
+ """
+ Compare the S data values to minimum thresholds and warn if the threshold appears large relative to the data
+
+ Warnings will be raised if [max(S) * s_relative_threshold] is less than s_absolute_threshold. These
+ thresholds are defined in the AbinsParameters.sampling dictionary.
+
+ :param return_cases: If True, return a list of cases where S was small compared to threshold.
+ :type return_cases: bool
+
+ :returns: If return_cases=True, this method returns a list of cases which failed the test, as tuples of
+ ``(atom_key, order_number, max(S))``. Otherwise, the method returns ``None``.
+
+ """
+
+ if logger is None:
+ logger = mantid_logger
+
+ warning_cases = []
+ absolute_threshold = AbinsParameters.sampling['s_absolute_threshold']
+ relative_threshold = AbinsParameters.sampling['s_relative_threshold']
+ for key, entry in self._data.items():
+ if AbinsConstants.ATOM_LABEL in key:
+ for order, s in entry['s'].items():
+ if max(s.flatten()) * relative_threshold < absolute_threshold:
+ warning_cases.append((key, order, max(s.flatten())))
+
+ if len(warning_cases) > 0:
+ logger.warning("Warning: some contributions had small S compared to threshold.")
+ logger.warning("The minimum S threshold ({}) is greater than {}% of the "
+ "maximum S for the following:".format(absolute_threshold,
+ relative_threshold * 100))
+
+ # Sort the warnings by atom number, order number
+ # Assuming that keys will be of form "atom_1", "atom_2", ...
+ # and "order_1", "order_2", ...
+ def int_key(case):
+ key, order, _ = case
+ return (int(key.split('_')[-1]), int(order.split('_')[-1]))
+
+ for case in sorted(warning_cases, key=int_key):
+ logger.warning("{0}, {1}: max S {2:10.4E}".format(*case))
+
+ if return_cases:
+ return warning_cases
+ else:
+ return None
+
def __str__(self):
return "Dynamical structure factors data"
diff --git a/scripts/AbinsModules/SPowderSemiEmpiricalCalculator.py b/scripts/AbinsModules/SPowderSemiEmpiricalCalculator.py
index 8194c0731166ce7a5f1f88d7539aa8ed12f9f8eb..3d60558cc9d0531bb5cd9adae7a89a9cadb9d7bf 100644
--- a/scripts/AbinsModules/SPowderSemiEmpiricalCalculator.py
+++ b/scripts/AbinsModules/SPowderSemiEmpiricalCalculator.py
@@ -6,7 +6,7 @@
# SPDX - License - Identifier: GPL - 3.0 +
from __future__ import (absolute_import, division, print_function)
import AbinsModules
-from AbinsModules import AbinsParameters
+from AbinsModules import AbinsParameters, AbinsConstants
import gc
try:
# noinspection PyUnresolvedReferences
@@ -17,24 +17,6 @@ except ImportError:
import numpy as np
-# Helper class for handling stability issues with S threshold for one atom and one quantum event.
-class StabilityError(Exception):
- def __init__(self, value=None):
- self._value = value
-
- def __str__(self):
- return self._value
-
-
-# Helper class for handling stability issues with S threshold for all atoms and all quantum events.
-class StabilityErrorAllAtoms(Exception):
- def __init__(self, value=None):
- self._value = value
-
- def __str__(self):
- return self._value
-
-
# noinspection PyMethodMayBeStatic
class SPowderSemiEmpiricalCalculator(object):
"""
@@ -72,8 +54,8 @@ class SPowderSemiEmpiricalCalculator(object):
else:
raise ValueError("Object of type AbinsData was expected.")
- min_order = AbinsModules.AbinsConstants.FUNDAMENTALS
- max_order = AbinsModules.AbinsConstants.FUNDAMENTALS + AbinsModules.AbinsConstants.HIGHER_ORDER_QUANTUM_EVENTS
+ min_order = AbinsConstants.FUNDAMENTALS
+ max_order = AbinsConstants.FUNDAMENTALS + AbinsConstants.HIGHER_ORDER_QUANTUM_EVENTS
if isinstance(quantum_order_num, int) and min_order <= quantum_order_num <= max_order:
self._quantum_order_num = quantum_order_num
else:
@@ -102,10 +84,10 @@ class SPowderSemiEmpiricalCalculator(object):
temperature=self._temperature))
self._freq_generator = AbinsModules.FrequencyPowderGenerator()
- self._calculate_order = {AbinsModules.AbinsConstants.QUANTUM_ORDER_ONE: self._calculate_order_one,
- AbinsModules.AbinsConstants.QUANTUM_ORDER_TWO: self._calculate_order_two,
- AbinsModules.AbinsConstants.QUANTUM_ORDER_THREE: self._calculate_order_three,
- AbinsModules.AbinsConstants.QUANTUM_ORDER_FOUR: self._calculate_order_four}
+ self._calculate_order = {AbinsConstants.QUANTUM_ORDER_ONE: self._calculate_order_one,
+ AbinsConstants.QUANTUM_ORDER_TWO: self._calculate_order_two,
+ AbinsConstants.QUANTUM_ORDER_THREE: self._calculate_order_three,
+ AbinsConstants.QUANTUM_ORDER_FOUR: self._calculate_order_four}
self._bin_width = bin_width # This is only here to store in s_data. Is that necessary/useful?
self._bins = np.arange(start=AbinsParameters.sampling['min_wavenumber'],
@@ -115,13 +97,7 @@ class SPowderSemiEmpiricalCalculator(object):
self._frequencies = self._bins[:-1] + (bin_width / 2)
self._freq_size = self._bins.size - 1
- # set initial threshold for s for each atom
self._num_atoms = len(self._abins_data.get_atoms_data().extract())
- s_threshold = AbinsParameters.sampling['s_relative_threshold']
- self._s_threshold_ref = np.asarray([s_threshold for _ in range(self._num_atoms)])
- self._s_current_threshold = np.copy(self._s_threshold_ref)
- self._max_s_previous_order = np.asarray([0.0 for _ in range(self._num_atoms)])
- self._total_s_correction_num_attempt = 0
self._powder_atoms_data = None
self._a_traces = None
@@ -141,121 +117,36 @@ class SPowderSemiEmpiricalCalculator(object):
# calculate S
calculate_s_powder = None
- if self._instrument.get_name() in AbinsModules.AbinsConstants.ONE_DIMENSIONAL_INSTRUMENTS:
+ if self._instrument.get_name() in AbinsConstants.ONE_DIMENSIONAL_INSTRUMENTS:
calculate_s_powder = self._calculate_s_powder_1d
s_data = calculate_s_powder()
return s_data
- def _calculate_s_over_threshold(self, s=None, freq=None, coeff=None, atom=None, order=None):
+ def _calculate_s_over_threshold(self, s=None, freq=None, coeff=None):
"""
Discards frequencies for small S.
:param s: numpy array with S for the given order quantum event and atom
:param freq: frequencies which correspond to s
:param coeff: coefficients which correspond to freq
- :param atom: number of atom
- :param order: order of quantum event
- :returns: large enough s, and corresponding freq, coeff and also if calculation is stable
- """
- s_max = np.max(s)
- threshold = max(s_max * self._s_current_threshold[atom], AbinsParameters.sampling['s_absolute_threshold'])
- small_s = AbinsModules.AbinsConstants.SMALL_S
-
- if order == AbinsModules.AbinsConstants.FUNDAMENTALS:
- self._max_s_previous_order[atom] = max(s_max, small_s)
- else:
- max_threshold = AbinsModules.AbinsConstants.MAX_THRESHOLD
- is_not_smaller = s_max - self._max_s_previous_order[atom] > 1.3 * self._max_s_previous_order[atom]
- allow_attempts = self._s_current_threshold[atom] < max_threshold
-
- if is_not_smaller and allow_attempts:
-
- msg = ("Numerical instability detected. Threshold for S has to be increased." +
- " Current max S is {} and the previous is {} for order {}."
- .format(s_max, self._max_s_previous_order[atom], order))
- raise StabilityError(msg)
- else:
- self._max_s_previous_order[atom] = max(s_max, small_s)
+ :returns: freq, coeff corresponding to S greater than AbinsParameters.sampling['s_absolute_threshold']
+ """
- indices = s > threshold
- # indices are guaranteed to be a numpy array (but can be an empty numpy array)
- # noinspection PyUnresolvedReferences
- if indices.any():
+ indices = s > AbinsParameters.sampling['s_absolute_threshold']
+ # Mask out small values, but avoid returning an array smaller than MIN_SIZE
+ if np.count_nonzero(indices) >= AbinsConstants.MIN_SIZE:
freq = freq[indices]
coeff = coeff[indices]
else:
-
- freq = freq[:AbinsModules.AbinsConstants.MIN_SIZE]
- coeff = coeff[:AbinsModules.AbinsConstants.MIN_SIZE]
+ freq = freq[:AbinsConstants.MIN_SIZE]
+ coeff = coeff[:AbinsConstants.MIN_SIZE]
return freq, coeff
- def _check_tot_s(self, tot_s=None):
- """
- Checks if total S for each quantum order event is consistent (it is expected that maximum intensity for n-th
- order is larger than maximum intensity for n+1-th order ).
- :param tot_s: dictionary with S for all atoms and all quantum events
- """
- s_temp = np.zeros_like(tot_s["atom_0"]["s"]["order_1"])
- previous_s_max = 0.0
- for order in range(AbinsModules.AbinsConstants.FUNDAMENTALS,
- self._quantum_order_num + AbinsModules.AbinsConstants.S_LAST_INDEX):
- s_temp.fill(0.0)
- for atom in range(self._num_atoms):
- s_temp += tot_s["atom_{}".format(atom)]["s"]["order_{}".format(order)]
- if order == AbinsModules.AbinsConstants.FUNDAMENTALS:
- previous_s_max = np.max(s_temp)
- else:
-
- current_s_max = np.max(s_temp)
- allow_attempts = np.median(self._s_current_threshold) < AbinsModules.AbinsConstants.MAX_THRESHOLD
-
- if previous_s_max <= current_s_max and allow_attempts:
- raise StabilityErrorAllAtoms(
- "Numerical instability detected for all atoms for order {}".format(order))
- else:
- previous_s_max = current_s_max
-
- def _s_threshold_up(self, atom=None):
- """
- If index of atom is given then sets new higher threshold for S for the given atom. If no atom is specified then
- threshold is increased for all atoms.
- :param atom: number of atom
- """
- intend = AbinsModules.AbinsConstants.S_THRESHOLD_CHANGE_INDENTATION
- if atom is None:
-
- self._s_current_threshold = self._s_threshold_ref * 2**self._total_s_correction_num_attempt
- self._report_progress(
- intend + "Threshold for S has been changed to {} for all atoms."
- .format(self._s_current_threshold[0]) + " S for all atoms will be calculated from scratch.")
-
- else:
-
- self._s_current_threshold[atom] += self._s_threshold_ref[atom]
-
- if self._s_current_threshold[atom] > AbinsModules.AbinsConstants.MAX_THRESHOLD:
- raise StabilityErrorAllAtoms(
- "Numerical instability detected. To large threshold for the individual atom. Threshold for all "
- "atoms should be raised.")
-
- atom_symbol = self._atoms["atom_{}".format(atom)]["symbol"]
- self._report_progress(
- intend + "Threshold for S has been changed to {} for atom {} ({})."
- .format(self._s_current_threshold[atom], atom, atom_symbol) +
- " S for this atom will be calculated from scratch.")
-
- def _s_threshold_reset(self):
- """
- Reset threshold for S to the initial value.
- """
- self._s_current_threshold = np.copy(self._s_threshold_ref)
- self._total_s_correction_num_attempt = 0
-
def _calculate_s_powder_over_k(self):
"""
Helper function. It calculates S for all q points and all atoms.
@@ -276,8 +167,8 @@ class SPowderSemiEmpiricalCalculator(object):
:param addition: S to be added
"""
for atom in range(self._num_atoms):
- for order in range(AbinsModules.AbinsConstants.FUNDAMENTALS,
- self._quantum_order_num + AbinsModules.AbinsConstants.S_LAST_INDEX):
+ for order in range(AbinsConstants.FUNDAMENTALS,
+ self._quantum_order_num + AbinsConstants.S_LAST_INDEX):
temp = addition["atom_%s" % atom]["s"]["order_%s" % order]
current_val["atom_%s" % atom]["s"]["order_%s" % order] += temp
@@ -303,20 +194,9 @@ class SPowderSemiEmpiricalCalculator(object):
Evaluates S for all atoms for the given q-point and checks if S is consistent.
:returns: Python dictionary with S data
"""
- self._s_threshold_reset()
- while True:
- try:
-
- s_all_atoms = self._calculate_s_powder_over_atoms_core(q_indx=q_indx)
- self._check_tot_s(tot_s=s_all_atoms)
- return s_all_atoms
-
- except StabilityErrorAllAtoms as e:
-
- self._report_progress("{}".format(e))
- self._total_s_correction_num_attempt += 1
- self._s_threshold_up()
+ s_all_atoms = self._calculate_s_powder_over_atoms_core(q_indx=q_indx)
+ return s_all_atoms
def _calculate_s_powder_over_atoms_core(self, q_indx=None):
"""
@@ -358,7 +238,7 @@ class SPowderSemiEmpiricalCalculator(object):
dft_data = clerk.load(list_of_datasets=["frequencies", "weights"])
frequencies = dft_data["datasets"]["frequencies"][int(k_point)]
- indx = frequencies > AbinsModules.AbinsConstants.ACOUSTIC_PHONON_THRESHOLD
+ indx = frequencies > AbinsConstants.ACOUSTIC_PHONON_THRESHOLD
self._fundamentals_freq = frequencies[indx]
self._weight = dft_data["datasets"]["weights"][int(k_point)]
@@ -366,7 +246,8 @@ class SPowderSemiEmpiricalCalculator(object):
# free memory
gc.collect()
- def _report_progress(self, msg):
+ @staticmethod
+ def _report_progress(msg):
"""
:param msg: message to print out
"""
@@ -381,15 +262,9 @@ class SPowderSemiEmpiricalCalculator(object):
logger.notice(msg)
def _calculate_s_powder_one_atom(self, atom=None):
+ s = self._calculate_s_powder_one_atom_core(atom=atom)
- while True:
- try:
- s = self._calculate_s_powder_one_atom_core(atom=atom)
- return s
- except StabilityError as e:
-
- self._report_progress("{}".format(e))
- self._s_threshold_up(atom=atom)
+ return s
def _calculate_s_powder_one_atom_core(self, atom=None):
"""
@@ -400,11 +275,11 @@ class SPowderSemiEmpiricalCalculator(object):
local_freq = np.copy(self._fundamentals_freq)
local_coeff = np.arange(start=0.0, step=1.0, stop=self._fundamentals_freq.size,
- dtype=AbinsModules.AbinsConstants.INT_TYPE)
+ dtype=AbinsConstants.INT_TYPE)
fund_coeff = np.copy(local_coeff)
- for order in range(AbinsModules.AbinsConstants.FUNDAMENTALS,
- self._quantum_order_num + AbinsModules.AbinsConstants.S_LAST_INDEX):
+ for order in range(AbinsConstants.FUNDAMENTALS,
+ self._quantum_order_num + AbinsConstants.S_LAST_INDEX):
# in case there is large number of transitions chop it into chunks and process chunk by chunk
if local_freq.size * self._fundamentals_freq.size > AbinsParameters.performance['optimal_size']:
@@ -418,7 +293,7 @@ class SPowderSemiEmpiricalCalculator(object):
part_loc_coeff = np.copy(local_coeff)
# number of transitions can only go up
- for lg_order in range(order, self._quantum_order_num + AbinsModules.AbinsConstants.S_LAST_INDEX):
+ for lg_order in range(order, self._quantum_order_num + AbinsConstants.S_LAST_INDEX):
part_loc_freq, part_loc_coeff, part_broad_spectrum = self._helper_atom(
atom=atom, local_freq=part_loc_freq, local_coeff=part_loc_coeff,
@@ -450,21 +325,21 @@ class SPowderSemiEmpiricalCalculator(object):
l_size = local_freq.size
opt_size = float(AbinsParameters.performance['optimal_size'])
- chunk_size = max(1.0, np.floor(opt_size / (l_size * 2**(AbinsModules.AbinsConstants.MAX_ORDER - order))))
+ chunk_size = max(1.0, np.floor(opt_size / (l_size * 2**(AbinsConstants.MAX_ORDER - order))))
chunk_num = int(np.ceil(float(fund_size) / chunk_size))
new_dim = int(chunk_num * chunk_size)
- new_fundamentals = np.zeros(shape=new_dim, dtype=AbinsModules.AbinsConstants.FLOAT_TYPE)
- new_fundamentals_coeff = np.zeros(shape=new_dim, dtype=AbinsModules.AbinsConstants.INT_TYPE)
+ new_fundamentals = np.zeros(shape=new_dim, dtype=AbinsConstants.FLOAT_TYPE)
+ new_fundamentals_coeff = np.zeros(shape=new_dim, dtype=AbinsConstants.INT_TYPE)
new_fundamentals[:fund_size] = self._fundamentals_freq
new_fundamentals_coeff[:fund_size] = np.arange(start=0.0, step=1.0, stop=self._fundamentals_freq.size,
- dtype=AbinsModules.AbinsConstants.INT_TYPE)
+ dtype=AbinsConstants.INT_TYPE)
new_fundamentals = new_fundamentals.reshape(chunk_num, int(chunk_size))
new_fundamentals_coeff = new_fundamentals_coeff.reshape(chunk_num, int(chunk_size))
total_size = self._freq_size
- for lg_order in range(order, self._quantum_order_num + AbinsModules.AbinsConstants.S_LAST_INDEX):
- s["order_%s" % lg_order] = np.zeros(shape=total_size, dtype=AbinsModules.AbinsConstants.FLOAT_TYPE)
+ for lg_order in range(order, self._quantum_order_num + AbinsConstants.S_LAST_INDEX):
+ s["order_%s" % lg_order] = np.zeros(shape=total_size, dtype=AbinsConstants.FLOAT_TYPE)
return new_fundamentals, new_fundamentals_coeff
@@ -489,7 +364,7 @@ class SPowderSemiEmpiricalCalculator(object):
if local_freq.any(): # check if local_freq has non-zero values
q2 = None
- if self._instrument.get_name() in AbinsModules.AbinsConstants.ONE_DIMENSIONAL_INSTRUMENTS:
+ if self._instrument.get_name() in AbinsConstants.ONE_DIMENSIONAL_INSTRUMENTS:
q2 = self._instrument.calculate_q_powder(input_data=local_freq)
value_dft = self._calculate_order[order](q2=q2,
@@ -508,9 +383,7 @@ class SPowderSemiEmpiricalCalculator(object):
local_freq, local_coeff = self._calculate_s_over_threshold(s=value_dft,
freq=local_freq,
- coeff=local_coeff,
- atom=atom,
- order=order)
+ coeff=local_coeff)
else:
rebinned_broad_spectrum = np.zeros_like(self._frequencies)
@@ -536,8 +409,8 @@ class SPowderSemiEmpiricalCalculator(object):
:returns: s for the first quantum order event for the given atom
"""
trace_ba = np.einsum('kli, il->k', b_tensor, a_tensor)
- coth = 1.0 / np.tanh(frequencies * AbinsModules.AbinsConstants.CM1_2_HARTREE /
- (2.0 * self._temperature * AbinsModules.AbinsConstants.K_2_HARTREE))
+ coth = 1.0 / np.tanh(frequencies * AbinsConstants.CM1_2_HARTREE
+ / (2.0 * self._temperature * AbinsConstants.K_2_HARTREE))
s = q2 * b_trace / 3.0 * np.exp(-q2 * (a_trace + 2.0 * trace_ba / b_trace) / 5.0 * coth * coth)
@@ -558,8 +431,8 @@ class SPowderSemiEmpiricalCalculator(object):
:param b_trace: frequency dependent MSD trace for the given atom
:returns: s for the second quantum order event for the given atom
"""
- coth = 1.0 / np.tanh(frequencies * AbinsModules.AbinsConstants.CM1_2_HARTREE /
- (2.0 * self._temperature * AbinsModules.AbinsConstants.K_2_HARTREE))
+ coth = 1.0 / np.tanh(frequencies * AbinsConstants.CM1_2_HARTREE
+ / (2.0 * self._temperature * AbinsConstants.K_2_HARTREE))
dw = np.exp(-q2 * a_trace / 3.0 * coth * coth)
q4 = q2 ** 2
@@ -586,16 +459,13 @@ class SPowderSemiEmpiricalCalculator(object):
# np.einsum('kli, kil->k', np.take(b_tensor, indices=indices[:, 1], axis=0),
# np.take(b_tensor, indices=indices[:, 0], axis=0)))
- s = q4 * dw * (np.prod(np.take(b_trace, indices=indices), axis=1) +
-
- np.einsum('kli, kil->k',
- np.take(b_tensor, indices=indices[:, 0], axis=0),
- np.take(b_tensor, indices=indices[:, 1], axis=0)) +
-
- np.einsum('kli, kil->k',
- np.take(b_tensor, indices=indices[:, 1], axis=0),
- np.take(b_tensor, indices=indices[:, 0], axis=0))) / (30.0 * factor)
-
+ s = q4 * dw * (np.prod(np.take(b_trace, indices=indices), axis=1)
+ + np.einsum('kli, kil->k',
+ np.take(b_tensor, indices=indices[:, 0], axis=0),
+ np.take(b_tensor, indices=indices[:, 1], axis=0))
+ + np.einsum('kli, kil->k',
+ np.take(b_tensor, indices=indices[:, 1], axis=0),
+ np.take(b_tensor, indices=indices[:, 0], axis=0))) / (30.0 * factor)
return s
# noinspection PyUnusedLocal,PyUnusedLocal
@@ -612,10 +482,10 @@ class SPowderSemiEmpiricalCalculator(object):
:param b_trace: frequency dependent MSD trace for the given atom
:returns: s for the third quantum order event for the given atom
"""
- coth = 1.0 / np.tanh(frequencies * AbinsModules.AbinsConstants.CM1_2_HARTREE /
- (2.0 * self._temperature * AbinsModules.AbinsConstants.K_2_HARTREE))
- s = 9.0 / 1086.0 * q2 ** 3 * np.prod(np.take(b_trace, indices=indices), axis=1) * \
- np.exp(-q2 * a_trace / 3.0 * coth * coth)
+ coth = 1.0 / np.tanh(frequencies * AbinsConstants.CM1_2_HARTREE
+ / (2.0 * self._temperature * AbinsConstants.K_2_HARTREE))
+ s = (9.0 / 1086.0 * q2 ** 3 * np.prod(np.take(b_trace, indices=indices), axis=1)
+ * np.exp(-q2 * a_trace / 3.0 * coth * coth))
return s
@@ -633,10 +503,10 @@ class SPowderSemiEmpiricalCalculator(object):
:param b_trace: frequency dependent MSD trace for the given atom
:returns: s for the forth quantum order event for the given atom
"""
- coth = 1.0 / np.tanh(frequencies * AbinsModules.AbinsConstants.CM1_2_HARTREE /
- (2.0 * self._temperature * AbinsModules.AbinsConstants.K_2_HARTREE))
- s = 27.0 / 49250.0 * q2 ** 4 * np.prod(np.take(b_trace, indices=indices), axis=1) * \
- np.exp(-q2 * a_trace / 3.0 * coth * coth)
+ coth = 1.0 / np.tanh(frequencies * AbinsConstants.CM1_2_HARTREE
+ / (2.0 * self._temperature * AbinsConstants.K_2_HARTREE))
+ s = (27.0 / 49250.0 * q2 ** 4 * np.prod(np.take(b_trace, indices=indices), axis=1)
+ * np.exp(-q2 * a_trace / 3.0 * coth * coth))
return s
@@ -689,8 +559,8 @@ class SPowderSemiEmpiricalCalculator(object):
n_atom = len([key for key in data["datasets"]["data"].keys() if "atom" in key])
for i in range(n_atom):
temp_data["atom_%s" % i] = {"s": dict()}
- for j in range(AbinsModules.AbinsConstants.FUNDAMENTALS,
- self._quantum_order_num + AbinsModules.AbinsConstants.S_LAST_INDEX):
+ for j in range(AbinsConstants.FUNDAMENTALS,
+ self._quantum_order_num + AbinsConstants.S_LAST_INDEX):
temp_val = data["datasets"]["data"]["atom_%s" % i]["s"]["order_%s" % j]
temp_data["atom_%s" % i]["s"].update({"order_%s" % j: temp_val})
@@ -721,4 +591,6 @@ class SPowderSemiEmpiricalCalculator(object):
data = self.calculate_data()
self._report_progress(str(data) + " has been calculated.")
+ data.check_thresholds()
+
return data
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMaps_All.py b/scripts/Calibration/Examples/TubeCalibDemoMaps_All.py
index a55e454bbb7595ca360e14dc777f497e064e31b7..1ebcae835084fe2dbb72f0df28bc335772550769 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMaps_All.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMaps_All.py
@@ -102,7 +102,7 @@ def minimalInput(filename):
# == Get the calibration and put results into calibration table ==
calibrationTable = tube.calibrate(CalibInstWS, CalibratedComponent, knownPos, funcFactor)
# == Apply the Calibation ==
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
def provideTheExpectedValue(filename):
@@ -130,7 +130,7 @@ def provideTheExpectedValue(filename):
calibrationTable = tube.calibrate(CalibInstWS, CalibratedComponent, knownPos, funcFactor,
fitPar=fitPar)
# == Apply the Calibation ==
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
def changeMarginAndExpectedValue(filename):
@@ -172,7 +172,7 @@ def changeMarginAndExpectedValue(filename):
calibrationTable, peakTable = tube.calibrate(CalibInstWS, CalibratedComponent, knownPos, funcFactor,
fitPar=fitPar, plotTube=[1, 10, 100], outputPeak=True, margin=10)
# == Apply the Calibation ==
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
tube.savePeak(peakTable, 'TubeDemoMaps01.txt')
@@ -222,7 +222,7 @@ def improvingCalibrationSingleTube(filename):
fitPar=fitPar, outputPeak=True, plotTube=[18, 19, 20],
rangeList=[18, 19, 20])
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
# reload to reset the calibration applied
CalibInstWS = loadingStep(filename)
@@ -239,7 +239,7 @@ def improvingCalibrationSingleTube(filename):
fitPar=fitPar, outputPeak=True, rangeList=[18, 19, 20],
overridePeaks=overridePeaks)
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
# check using the InstrumentView and you will see that it is better than before
@@ -294,7 +294,7 @@ def improvingCalibrationOfListOfTubes(filename):
calibrationTable, peakTable = tube.calibrate(CalibInstWS, CalibratedComponent, knownPos, funcFactor,
fitPar=fitPar, outputPeak=True, overridePeaks=define_peaks)
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
def calibrateB2Window(filename):
@@ -334,7 +334,7 @@ def calibrateB2Window(filename):
fitPar=fitPar, outputPeak=True, plotTube=[b2_range[0], b2_range[-1]],
rangeList=b2_range)
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
def findThoseTubesThatNeedSpecialCareForCalibration(filename):
@@ -505,7 +505,7 @@ def completeCalibration(filename):
calibTable=calibrationTable, # it will append to the calibTable
rangeList=b2_window)
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
# == Save workspace ==
# mantid.SaveNexusProcessed(CalibInstWS, path+'TubeCalibDemoMapsResult.nxs', "Result of Running TCDemoMaps.py")
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMaps_B1.py b/scripts/Calibration/Examples/TubeCalibDemoMaps_B1.py
index ae94ba786a2f3eca481a2a8763adc15dc77c53d1..297b72e49b604a190f0ccfb8415f902783f5cfb4 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMaps_B1.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMaps_B1.py
@@ -58,7 +58,7 @@ calibrationTable, peakTable = tube.calibrate(CalibInstWS, CalibratedComponent, k
print("Got calibration (new positions of detectors) ")
# == Apply the Calibation ==
-mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
# == Save workspace ==
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMaps_C4C3.py b/scripts/Calibration/Examples/TubeCalibDemoMaps_C4C3.py
index 75853f3c1359391a84d1e56e6e8d599750cdb7dc..924b9041f7dee8de91b4e4b9b79e592e78571b18 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMaps_C4C3.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMaps_C4C3.py
@@ -55,7 +55,7 @@ calibrationTable, peakTable = tube.calibrate(CalibInstWS, thisTubeSet, knownPos,
print("Got calibration (new positions of detectors) ")
# == Apply the Calibation ==
-mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
# == Save workspace ==
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMaps_C4C3C2.py b/scripts/Calibration/Examples/TubeCalibDemoMaps_C4C3C2.py
index ea751189b24f07b50948c5a647055d7a83211a7e..75849602617edaee290b6c0f49fb7d059431fdff 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMaps_C4C3C2.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMaps_C4C3C2.py
@@ -48,7 +48,7 @@ calibrationTable, peakTable = tube.calibrate(CalibInstWS, CalibratedComponents,
print("Got calibration (new positions of detectors) ")
# == Apply the Calibation ==
-mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
# == Save workspace ==
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMaps_D2.py b/scripts/Calibration/Examples/TubeCalibDemoMaps_D2.py
index 8c81004bddf391365ca7962f3318f6b66ada4fa3..4c9da1b8ccb90d82eb48407c818b306fe73f6ddd 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMaps_D2.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMaps_D2.py
@@ -56,7 +56,7 @@ calibrationTable = tube.calibrate(CalibInstWS, CalibratedComponent, knownPos, fu
print("Got calibration (new positions of detectors) ")
# == Apply the Calibation ==
-mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
# == Save workspace ==
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMaps_D2_WideMargins.py b/scripts/Calibration/Examples/TubeCalibDemoMaps_D2_WideMargins.py
index 87baa43ed2f50b9a16088758b7d894f0a82c67f0..28a2d2ef24fce4701a563c5737a4086c14a46478 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMaps_D2_WideMargins.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMaps_D2_WideMargins.py
@@ -44,7 +44,7 @@ calibrationTable = tube.calibrate(CalibInstWS, CalibratedComponent, knownPos, fu
print("Got calibration (new positions of detectors) ")
# == Apply the Calibation ==
-mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMaps_D4.py b/scripts/Calibration/Examples/TubeCalibDemoMaps_D4.py
index 835c76361f68cdd0daee6c026f4d5fffc6707d4b..d09e09f151682998742405b7d6344cf1bfbb2b25 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMaps_D4.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMaps_D4.py
@@ -55,7 +55,7 @@ calibrationTable = tube.calibrate(CalibInstWS, CalibratedComponent, knownPos, fu
print("Got calibration (new positions of detectors) ")
# == Apply the Calibation ==
-mantid.ApplyCalibration( Workspace=CalibInstWS, PositionTable=calibrationTable)
+mantid.ApplyCalibration( Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMerlin.py b/scripts/Calibration/Examples/TubeCalibDemoMerlin.py
index 9f98141118bb0d7ede55507c70af30f6108ab7a9..cccfd0c054686db39f04509032f2bc1603e85765 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMerlin.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMerlin.py
@@ -231,7 +231,7 @@ def calibrateMerlin(filename):
analisePeakTable(peakTable, 'door3_peaks')
# == Apply the Calibation ==
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
# == Save workspace ==
diff --git a/scripts/Calibration/Examples/TubeCalibDemoMerlin_Simple.py b/scripts/Calibration/Examples/TubeCalibDemoMerlin_Simple.py
index 866a3f1238412af4a7777488d28102ea811777fa..5151d4ce4eb9d44e457c05098bb376e187a22738 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoMerlin_Simple.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoMerlin_Simple.py
@@ -85,7 +85,7 @@ def CalibrateMerlin(RunNumber):
print("Got calibration (new positions of detectors) and put slit peaks into file TubeDemoMerlin01.txt")
# == Apply the Calibation ==
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
# == Save workspace ==
diff --git a/scripts/Calibration/Examples/TubeCalibDemoWish0.py b/scripts/Calibration/Examples/TubeCalibDemoWish0.py
index 5f7123755cebefd977769c59021b98466bebf641..fb278df9bc6797dc204b2c099a67296a063a374e 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoWish0.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoWish0.py
@@ -39,5 +39,5 @@ calibrationTable = tube.calibrate(CalibInstWS, CalibratedComponent,
print("Got calibration (new positions of detectors)")
#Apply the calibration
-mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
diff --git a/scripts/Calibration/Examples/TubeCalibDemoWish1.py b/scripts/Calibration/Examples/TubeCalibDemoWish1.py
index 4684e692ef6540e8c6bc7f49b11cfe0db7cb5a1e..177c0e1df82f5249a57041a4930c509bf09b70e0 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoWish1.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoWish1.py
@@ -51,5 +51,5 @@ calibrationTable = tube.calibrate( CalibInstWS, 'WISH/panel03', known_pos, func_
print("Got calibration (new positions of detectors)")
#Apply the calibration
-mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
diff --git a/scripts/Calibration/Examples/TubeCalibDemoWish_Simple.py b/scripts/Calibration/Examples/TubeCalibDemoWish_Simple.py
index 032dddb359518ef16277d52cfb7a12ce3489f80c..29f94e5af09f951797f4a8d44c6ac7419d401128 100644
--- a/scripts/Calibration/Examples/TubeCalibDemoWish_Simple.py
+++ b/scripts/Calibration/Examples/TubeCalibDemoWish_Simple.py
@@ -62,7 +62,7 @@ def CalibrateWish(RunNumber, PanelNumber):
print("Got calibration (new positions of detectors)")
# Apply the calibration
- mantid.ApplyCalibration(Workspace=CalibInstWS, PositionTable=calibrationTable)
+ mantid.ApplyCalibration(Workspace=CalibInstWS, CalibrationTable=calibrationTable)
print("Applied calibration")
# == Save workspace ==
diff --git a/scripts/Engineering/gui/engineering_diffraction/engineering_diffraction.py b/scripts/Engineering/gui/engineering_diffraction/engineering_diffraction.py
index 9355570ab648b370430d31d07e88b9de474bf5a1..518b615fedbc06ea225f1f4804a3d223f5aed02d 100644
--- a/scripts/Engineering/gui/engineering_diffraction/engineering_diffraction.py
+++ b/scripts/Engineering/gui/engineering_diffraction/engineering_diffraction.py
@@ -57,6 +57,16 @@ class EngineeringDiffractionGui(QtWidgets.QMainWindow, Ui_main_window):
# Setup notifiers
self.setup_calibration_notifier()
+ # Usage Reporting
+ try:
+ import mantid
+
+ # register startup
+ mantid.UsageService.registerFeatureUsage(mantid.kernel.FeatureType.Interface,
+ "Engineering Diffraction", False)
+ except ImportError:
+ pass
+
def setup_settings(self):
model = SettingsModel()
view = SettingsView(self)
diff --git a/scripts/Engineering/gui/engineering_diffraction/main_window.ui b/scripts/Engineering/gui/engineering_diffraction/main_window.ui
index 2f4386b06fdf8c1afffdbc69a1a8ad07c730c650..492e163ca968b43c2a444b39f9fa292916879b35 100644
--- a/scripts/Engineering/gui/engineering_diffraction/main_window.ui
+++ b/scripts/Engineering/gui/engineering_diffraction/main_window.ui
@@ -6,8 +6,8 @@
<rect>
<x>0</x>
<y>0</y>
- <width>640</width>
- <height>253</height>
+ <width>638</width>
+ <height>848</height>
</rect>
</property>
<property name="windowTitle">
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_model.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_model.py
index 2988218ffd4d461594634d94f7790028305d4d06..087ae016f69f95eb64e18cb8bf9adf42c9cbe6fb 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_model.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_model.py
@@ -13,13 +13,22 @@ from mantid.simpleapi import Load, logger
class FittingDataModel(object):
def __init__(self):
self._loaded_workspaces = {} # Map stores using {WorkspaceName: Workspace}
+ self._last_added = [] # List of workspace names loaded in the last load action.
def load_files(self, filenames_string):
+ self._last_added = []
filenames = [name.strip() for name in filenames_string.split(",")]
for filename in filenames:
ws_name = self._generate_workspace_name(filename)
try:
- self._loaded_workspaces[ws_name] = Load(filename, OutputWorkspace=ws_name)
+ ws = Load(filename, OutputWorkspace=ws_name)
+ if ws.getNumberHistograms() == 1:
+ self._loaded_workspaces[ws_name] = ws
+ self._last_added.append(ws_name)
+ else:
+ logger.warning(
+ "Invalid number of spectra in workspace {}. Skipping loading of file.".
+ format(ws_name))
except RuntimeError as e:
logger.error(
"Failed to load file: {}. Error: {}. \n Continuing loading of other files.".
@@ -28,6 +37,9 @@ class FittingDataModel(object):
def get_loaded_workspaces(self):
return self._loaded_workspaces
+ def get_last_added(self):
+ return self._last_added
+
def get_sample_log_from_ws(self, ws_name, log_name):
return self._loaded_workspaces[ws_name].getSampleDetails().getLogData(log_name).value
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_presenter.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_presenter.py
index fbf22015c723ca14220474766a0575caf049c33c..0759e4dda5ef0de21ca9ed1ea85c62bd92b8a4d3 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_presenter.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_presenter.py
@@ -8,6 +8,7 @@
from Engineering.gui.engineering_diffraction.tabs.common import create_error_message
from mantid.simpleapi import logger
from mantidqt.utils.asynchronous import AsyncTask
+from mantidqt.utils.observer_pattern import GenericObservable
class FittingDataPresenter(object):
@@ -17,12 +18,19 @@ class FittingDataPresenter(object):
self.worker = None
self.row_numbers = TwoWayRowDict() # {ws_name: table_row} and {table_row: ws_name}
+ self.plotted = set() # List of plotted workspace names
# Connect view signals to local methods
self.view.set_on_load_clicked(self.on_load_clicked)
self.view.set_enable_button_connection(self._enable_load_button)
self.view.set_on_remove_selected_clicked(self._remove_selected_tracked_workspaces)
self.view.set_on_remove_all_clicked(self._remove_all_tracked_workspaces)
+ self.view.set_on_table_cell_changed(self._handle_table_cell_changed)
+
+ # Observable Setup
+ self.plot_added_notifier = GenericObservable()
+ self.plot_removed_notifier = GenericObservable()
+ self.all_plots_removed_notifier = GenericObservable()
def on_load_clicked(self):
if self._validate():
@@ -31,23 +39,32 @@ class FittingDataPresenter(object):
def remove_workspace(self, ws_name):
if ws_name in self.get_loaded_workspaces():
- self.get_loaded_workspaces().pop(ws_name)
+ removed = self.get_loaded_workspaces().pop(ws_name)
+ self.plot_removed_notifier.notify_subscribers(removed)
+ self.plotted.discard(ws_name)
self._repopulate_table()
def rename_workspace(self, old_name, new_name):
- if old_name in self.get_loaded_workspaces():
- self.get_loaded_workspaces()[new_name] = self.get_loaded_workspaces().pop(
- old_name)
+ loaded_workspaces = self.get_loaded_workspaces()
+ if old_name in loaded_workspaces:
+ ws = loaded_workspaces.pop(old_name)
+ loaded_workspaces[new_name] = ws
+ if old_name in self.plotted:
+ self.plotted.remove(old_name)
+ self.plotted.add(new_name)
self._repopulate_table()
def clear_workspaces(self):
self.get_loaded_workspaces().clear()
+ self.plotted.clear()
self.row_numbers.clear()
self._repopulate_table()
def replace_workspace(self, name, workspace):
if name in self.get_loaded_workspaces():
self.get_loaded_workspaces()[name] = workspace
+ if name in self.plotted:
+ self.all_plots_removed_notifier.notify_subscribers()
self._repopulate_table()
def get_loaded_workspaces(self):
@@ -69,11 +86,18 @@ class FittingDataPresenter(object):
self._emit_enable_button_signal()
def _on_worker_success(self, _):
+ if self.view.get_add_to_plot():
+ self.plotted.update(self.model.get_last_added())
self._repopulate_table()
def _repopulate_table(self):
+ """
+ Populate the table with the information from the loaded workspaces.
+ Will also handle any workspaces that need to be plotted.
+ """
self._remove_all_table_rows()
self.row_numbers.clear()
+ self.all_plots_removed_notifier.notify_subscribers()
workspaces = self.get_loaded_workspaces()
for i, name in enumerate(workspaces):
try:
@@ -81,21 +105,36 @@ class FittingDataPresenter(object):
bank = self.model.get_sample_log_from_ws(name, "bankid")
if bank == 0:
bank = "cropped"
- self._add_row_to_table(name, i, run_no, bank)
+ checked = name in self.plotted
+ self._add_row_to_table(name, i, run_no, bank, checked)
except RuntimeError:
self._add_row_to_table(name, i)
+ self._handle_table_cell_changed(i, 2)
def _remove_selected_tracked_workspaces(self):
row_numbers = self._remove_selected_table_rows()
for row_no in row_numbers:
ws_name = self.row_numbers.pop(row_no)
- self.get_loaded_workspaces().pop(ws_name)
+ removed = self.get_loaded_workspaces().pop(ws_name)
+ self.plot_removed_notifier.notify_subscribers(removed)
+ self.plotted.discard(ws_name)
self._repopulate_table()
def _remove_all_tracked_workspaces(self):
self.clear_workspaces()
self._remove_all_table_rows()
+ def _handle_table_cell_changed(self, row, col):
+ if col == 2 and row in self.row_numbers: # Is from the plot check column
+ ws = self.model.get_loaded_workspaces()[self.row_numbers[row]]
+ ws_name = self.row_numbers[row]
+ if self.view.get_item_checked(row, col): # Plot Box is checked
+ self.plot_added_notifier.notify_subscribers(ws)
+ self.plotted.add(ws_name)
+ else: # Plot box is unchecked
+ self.plot_removed_notifier.notify_subscribers(ws)
+ self.plotted.discard(ws_name)
+
def _enable_load_button(self, enabled):
self.view.set_load_button_enabled(enabled)
@@ -120,21 +159,21 @@ class FittingDataPresenter(object):
return False
return True
- def _add_row_to_table(self, ws_name, row, run_no=None, bank=None):
+ def _add_row_to_table(self, ws_name, row, run_no=None, bank=None, checked=False):
words = ws_name.split("_")
if run_no is not None and bank is not None:
- self.view.add_table_row(run_no, bank)
+ self.view.add_table_row(run_no, bank, checked)
self.row_numbers[ws_name] = row
elif len(words) == 4 and words[2] == "bank":
logger.notice("No sample logs present, determining information from workspace name.")
- self.view.add_table_row(words[1], words[3])
+ self.view.add_table_row(words[1], words[3], checked)
self.row_numbers[ws_name] = row
else:
logger.warning(
"The workspace '{}' was not in the correct naming format. Files should be named in the following way: "
"INSTRUMENT_RUNNUMBER_bank_BANK. Using workspace name as identifier.".format(ws_name)
)
- self.view.add_table_row(ws_name, "N/A")
+ self.view.add_table_row(ws_name, "N/A", checked)
self.row_numbers[ws_name] = row
def _remove_table_row(self, row_no):
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_view.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_view.py
index b07a1349cb67e5bfbc96a2d7eb278a4f01f48204..be6a4313cb69ccbf71635f65dea85d0c8422d321 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_view.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_view.py
@@ -50,14 +50,25 @@ class FittingDataView(QtWidgets.QWidget, Ui_data):
def set_load_button_enabled(self, enabled):
self.button_load.setEnabled(enabled)
- def add_table_row(self, run_no, bank):
+ def add_table_row(self, run_no, bank, checked):
row_no = self.table_selection.rowCount()
self.table_selection.insertRow(row_no)
- self.table_selection.setItem(row_no, 0, QtWidgets.QTableWidgetItem(str(run_no)))
- self.table_selection.setItem(row_no, 1, QtWidgets.QTableWidgetItem(str(bank)))
+
+ name_item = QtWidgets.QTableWidgetItem(str(run_no))
+ name_item.setFlags(name_item.flags() & ~QtCore.Qt.ItemIsEditable)
+ self.table_selection.setItem(row_no, 0, name_item)
+
+ bank_item = QtWidgets.QTableWidgetItem(str(bank))
+ bank_item.setFlags(name_item.flags() & ~QtCore.Qt.ItemIsEditable)
+ self.table_selection.setItem(row_no, 1, bank_item)
+
check_box = QtWidgets.QTableWidgetItem()
- check_box.setCheckState(QtCore.Qt.Unchecked)
+ check_box.setFlags(check_box.flags() & ~QtCore.Qt.ItemIsEditable)
self.table_selection.setItem(row_no, 2, check_box)
+ if checked:
+ check_box.setCheckState(QtCore.Qt.Checked)
+ else:
+ check_box.setCheckState(QtCore.Qt.Unchecked)
def remove_table_row(self, row_no):
self.table_selection.removeRow(row_no)
@@ -87,6 +98,12 @@ class FittingDataView(QtWidgets.QWidget, Ui_data):
def get_selected_rows(self):
return set(index.row() for index in self.table_selection.selectedIndexes())
+ def get_table_item(self, row, col):
+ return self.table_selection.item(row, col)
+
+ def get_item_checked(self, row, col):
+ return self.get_table_item(row, col).checkState() == QtCore.Qt.Checked
+
# =================
# State Getters
# =================
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_widget.ui b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_widget.ui
index 05b6b6da259f70f2d395e57b5490a88a2f702126..ac1dee8dbf0fb067b69e5238db1aaeaa04a686c6 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_widget.ui
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/data_widget.ui
@@ -6,8 +6,8 @@
<rect>
<x>0</x>
<y>0</y>
- <width>477</width>
- <height>217</height>
+ <width>472</width>
+ <height>257</height>
</rect>
</property>
<property name="windowTitle">
@@ -103,6 +103,12 @@ QGroupBox:title {
<layout class="QVBoxLayout" name="verticalLayout">
<item>
<widget class="QTableWidget" name="table_selection">
+ <property name="minimumSize">
+ <size>
+ <width>0</width>
+ <height>120</height>
+ </size>
+ </property>
<property name="gridStyle">
<enum>Qt::SolidLine</enum>
</property>
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/test/test_data_model.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/test/test_data_model.py
index b1b323c40ef526abd059f399ed2be439d7be8406..d3b4d4a2cd205b1ba9dcdf857edb485e8fd5bfde 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/test/test_data_model.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/test/test_data_model.py
@@ -7,6 +7,7 @@
import unittest
+from mantid.py3compat import mock
from mantid.py3compat.mock import patch
from Engineering.gui.engineering_diffraction.tabs.fitting.data_handling.data_model import FittingDataModel
@@ -20,12 +21,14 @@ class TestFittingDataModel(unittest.TestCase):
@patch(file_path + ".Load")
def test_loading_single_file_stores_workspace(self, mock_load):
- mock_load.return_value = "mocked_workspace"
+ mock_ws = mock.MagicMock()
+ mock_ws.getNumberHistograms.return_value = 1
+ mock_load.return_value = mock_ws
self.model.load_files("/ar/a_filename.whatever")
self.assertEqual(1, len(self.model._loaded_workspaces))
- self.assertEqual("mocked_workspace", self.model._loaded_workspaces["a_filename"])
+ self.assertEqual(mock_ws, self.model._loaded_workspaces["a_filename"])
mock_load.assert_called_with("/ar/a_filename.whatever", OutputWorkspace="a_filename")
@patch(file_path + ".logger")
@@ -41,16 +44,32 @@ class TestFittingDataModel(unittest.TestCase):
@patch(file_path + ".Load")
def test_loading_multiple_files(self, mock_load):
- mock_load.return_value = "mocked_workspace"
+ mock_ws = mock.MagicMock()
+ mock_ws.getNumberHistograms.return_value = 1
+ mock_load.return_value = mock_ws
self.model.load_files("/dir/file1.txt, /dir/file2.nxs")
self.assertEqual(2, len(self.model._loaded_workspaces))
- self.assertEqual("mocked_workspace", self.model._loaded_workspaces["file1"])
- self.assertEqual("mocked_workspace", self.model._loaded_workspaces["file2"])
+ self.assertEqual(mock_ws, self.model._loaded_workspaces["file1"])
+ self.assertEqual(mock_ws, self.model._loaded_workspaces["file2"])
mock_load.assert_any_call("/dir/file1.txt", OutputWorkspace="file1")
mock_load.assert_any_call("/dir/file2.nxs", OutputWorkspace="file2")
+ @patch(file_path + ".logger")
+ @patch(file_path + ".Load")
+ def test_loading_multiple_files_too_many_spectra(self, mock_load, mock_logger):
+ mock_ws = mock.MagicMock()
+ mock_ws.getNumberHistograms.return_value = 2
+ mock_load.return_value = mock_ws
+
+ self.model.load_files("/dir/file1.txt, /dir/file2.nxs")
+
+ self.assertEqual(0, len(self.model._loaded_workspaces))
+ mock_load.assert_any_call("/dir/file1.txt", OutputWorkspace="file1")
+ mock_load.assert_any_call("/dir/file2.nxs", OutputWorkspace="file2")
+ self.assertEqual(2, mock_logger.warning.call_count)
+
@patch(file_path + ".logger")
@patch(file_path + ".Load")
def test_loading_multiple_files_invalid(self, mock_load, mock_logger):
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/test/test_data_presenter.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/test/test_data_presenter.py
index aec6e02de3dff8a8b4108915716a4fafef3c104d..475a1c93380573d319ed89366883ab60fe2dcac0 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/test/test_data_presenter.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/data_handling/test/test_data_presenter.py
@@ -73,24 +73,28 @@ class FittingDataPresenterTest(unittest.TestCase):
model_dict = {"ENGINX_1_bank_1": "ws1", "ENGINX_2_bank_South": "ws2"}
self.model.get_loaded_workspaces.return_value = model_dict
self.model.get_sample_log_from_ws.return_value = "bankOrRunNumber"
+ self.presenter.plot_added_notifier = mock.MagicMock()
+ self.presenter.all_plots_removed_notifier = mock.MagicMock()
self.presenter._on_worker_success("info")
self.assertEqual(1, self.view.remove_all.call_count)
- self.view.add_table_row.assert_any_call("bankOrRunNumber", "bankOrRunNumber")
- self.view.add_table_row.assert_any_call("bankOrRunNumber", "bankOrRunNumber")
+ self.view.add_table_row.assert_any_call("bankOrRunNumber", "bankOrRunNumber", False)
+ self.view.add_table_row.assert_any_call("bankOrRunNumber", "bankOrRunNumber", False)
@patch(dir_path + ".data_presenter.logger")
def test_worker_success_invalid_filename(self, mock_logger):
model_dict = {"invalid": "ws1", "invalid2": "ws2"}
self.model.get_loaded_workspaces.return_value = model_dict
self.model.get_sample_log_from_ws.side_effect = RuntimeError("No sample logs present")
+ self.presenter.plot_added_notifier = mock.MagicMock()
+ self.presenter.all_plots_removed_notifier = mock.MagicMock()
self.presenter._on_worker_success("info")
self.assertEqual(1, self.view.remove_all.call_count)
self.assertEqual(2, self.view.add_table_row.call_count)
- self.view.add_table_row.assert_any_call("invalid", "N/A")
+ self.view.add_table_row.assert_any_call("invalid", "N/A", False)
self.assertEqual(2, mock_logger.warning.call_count)
@patch(dir_path + ".data_presenter.logger")
@@ -98,24 +102,29 @@ class FittingDataPresenterTest(unittest.TestCase):
model_dict = {"INSTRUMENT_10_bank_2": "ws1", "INSTRUMENT_20_bank_1": "ws2"}
self.model.get_loaded_workspaces.return_value = model_dict
self.model.get_sample_log_from_ws.side_effect = RuntimeError("No sample logs present")
+ self.presenter.plot_added_notifier = mock.MagicMock()
+ self.presenter.all_plots_removed_notifier = mock.MagicMock()
self.presenter._on_worker_success("info")
self.assertEqual(1, self.view.remove_all.call_count)
self.assertEqual(2, self.view.add_table_row.call_count)
- self.view.add_table_row.assert_any_call("10", "2")
- self.view.add_table_row.assert_any_call("20", "1")
+ self.view.add_table_row.assert_any_call("10", "2", False)
+ self.view.add_table_row.assert_any_call("20", "1", False)
self.assertEqual(2, mock_logger.notice.call_count)
def test_remove_workspace_tracked(self):
model_dict = {"name1": "ws1", "name2": "ws2"}
self.model.get_loaded_workspaces.return_value = model_dict
self.presenter.row_numbers = {"name1": 0, "name2": 1}
+ self.presenter.plot_removed_notifier = mock.MagicMock()
+ self.presenter.all_plots_removed_notifier = mock.MagicMock()
self.presenter.remove_workspace("name1")
self.assertEqual({"name2": "ws2"}, model_dict)
self.assertEqual({"name2": 0}, self.presenter.row_numbers)
+ self.assertEqual(1, self.presenter.plot_removed_notifier.notify_subscribers.call_count)
def test_remove_workspace_not_tracked(self):
model_dict = {"name1": "ws1", "name2": "ws2"}
@@ -131,12 +140,14 @@ class FittingDataPresenterTest(unittest.TestCase):
model_dict = {"name1": "ws1", "name2": "ws2"}
self.model.get_loaded_workspaces.return_value = model_dict
self.presenter.row_numbers = {"name1": 0, "name2": 1}
+ self.presenter.all_plots_removed_notifier = mock.MagicMock()
self.presenter.rename_workspace("name1", "new")
self.assertEqual({"new": "ws1", "name2": "ws2"}, model_dict)
self.assertTrue("new" in self.presenter.row_numbers)
self.assertFalse("name1" is self.presenter.row_numbers)
+ self.assertEqual(1, self.presenter.all_plots_removed_notifier.notify_subscribers.call_count)
def test_rename_workspace_not_tracked(self):
model_dict = {"name1": "ws1", "name2": "ws2"}
@@ -152,16 +163,19 @@ class FittingDataPresenterTest(unittest.TestCase):
model_dict = {"name1": "ws1", "name2": "ws2"}
self.model.get_loaded_workspaces.return_value = model_dict
self.presenter.row_numbers = {"name1": 0, "name2": 1}
+ self.presenter.all_plots_removed_notifier = mock.MagicMock()
self.presenter.clear_workspaces()
self.assertEqual({}, model_dict)
self.assertEqual({}, self.presenter.row_numbers)
+ self.assertEqual(1, self.presenter.all_plots_removed_notifier.notify_subscribers.call_count)
def test_replace_workspace_tracked(self):
model_dict = {"name1": "ws1", "name2": "ws2"}
self.model.get_loaded_workspaces.return_value = model_dict
self.presenter.row_numbers = {"name1": 0, "name2": 1}
+ self.presenter.all_plots_removed_notifier = mock.MagicMock()
self.presenter.replace_workspace("name1", "newWs")
@@ -183,9 +197,13 @@ class FittingDataPresenterTest(unittest.TestCase):
self.presenter.row_numbers = data_presenter.TwoWayRowDict()
self.presenter.row_numbers["name1"] = 0
self.presenter.row_numbers["name2"] = 1
- model_dict = {"name1": "ws1", "name2": "ws2"}
+ self.presenter.row_numbers["name3"] = 2
+ model_dict = {"name1": "ws1", "name2": "ws2", "name3": "ws3"}
self.model.get_loaded_workspaces.return_value = model_dict
- self.view.remove_selected.return_value = [0]
+ self.view.remove_selected.return_value = [0, 2]
+ self.presenter.plot_removed_notifier = mock.MagicMock()
+ self.presenter.plot_added_notifier = mock.MagicMock()
+ self.presenter.all_plots_removed_notifier = mock.MagicMock()
self.presenter._remove_selected_tracked_workspaces()
@@ -194,6 +212,59 @@ class FittingDataPresenterTest(unittest.TestCase):
test_dict["name2"] = 0
self.assertEqual(self.presenter.row_numbers, test_dict)
self.assertEqual(model_dict, {"name2": "ws2"})
+ self.assertEqual(2, self.presenter.plot_removed_notifier.notify_subscribers.call_count)
+ self.assertEqual(1, self.presenter.plot_added_notifier.notify_subscribers.call_count)
+
+ def test_handle_table_cell_changed_checkbox_ticked(self):
+ mocked_table_item = mock.MagicMock()
+ mocked_table_item.checkState.return_value = 2
+ self.view.get_table_item.return_value = mocked_table_item
+ self.presenter.row_numbers = data_presenter.TwoWayRowDict()
+ self.presenter.row_numbers["name1"] = 0
+ self.presenter.row_numbers["name2"] = 1
+ model_dict = {"name1": "ws1", "name2": "ws2"}
+ self.model.get_loaded_workspaces.return_value = model_dict
+ self.presenter.plot_added_notifier = mock.MagicMock()
+ self.presenter.plot_removed_notifier = mock.MagicMock()
+
+ self.presenter._handle_table_cell_changed(0, 2)
+
+ self.assertEqual(1, self.presenter.plot_added_notifier.notify_subscribers.call_count)
+ self.presenter.plot_added_notifier.notify_subscribers.assert_any_call("ws1")
+ self.assertEqual(0, self.presenter.plot_removed_notifier.notify_subscribers.call_count)
+
+ def test_handle_table_cell_changed_checkbox_unticked(self):
+ self.view.get_item_checked.return_value = False
+ self.presenter.row_numbers = data_presenter.TwoWayRowDict()
+ self.presenter.row_numbers["name1"] = 0
+ self.presenter.row_numbers["name2"] = 1
+ model_dict = {"name1": "ws1", "name2": "ws2"}
+ self.model.get_loaded_workspaces.return_value = model_dict
+ self.presenter.plot_added_notifier = mock.MagicMock()
+ self.presenter.plot_removed_notifier = mock.MagicMock()
+
+ self.presenter._handle_table_cell_changed(0, 2)
+
+ self.assertEqual(0, self.presenter.plot_added_notifier.notify_subscribers.call_count)
+ self.assertEqual(1, self.presenter.plot_removed_notifier.notify_subscribers.call_count)
+ self.presenter.plot_removed_notifier.notify_subscribers.assert_any_call("ws1")
+
+ def test_handle_table_cell_changed_other_element(self):
+ mocked_table_item = mock.MagicMock()
+ mocked_table_item.checkState.return_value = 2
+ self.view.get_table_item.return_value = mocked_table_item
+ self.presenter.row_numbers = data_presenter.TwoWayRowDict()
+ self.presenter.row_numbers["name1"] = 0
+ self.presenter.row_numbers["name2"] = 1
+ model_dict = {"name1": "ws1", "name2": "ws2"}
+ self.model.get_loaded_workspaces.return_value = model_dict
+ self.presenter.plot_added_notifier = mock.MagicMock()
+ self.presenter.plot_removed_notifier = mock.MagicMock()
+
+ self.presenter._handle_table_cell_changed(1, 1)
+
+ self.assertEqual(0, self.presenter.plot_added_notifier.notify_subscribers.call_count)
+ self.assertEqual(0, self.presenter.plot_removed_notifier.notify_subscribers.call_count)
if __name__ == '__main__':
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/fitting_tab.ui b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/fitting_tab.ui
index 769f18202b4184c39e8ba34ff8f3ee6042d0c64b..d9b3ce94e0e6a7c7019baa4cf9d2b9bae99e665e 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/fitting_tab.ui
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/fitting_tab.ui
@@ -6,8 +6,8 @@
<rect>
<x>0</x>
<y>0</y>
- <width>632</width>
- <height>150</height>
+ <width>622</width>
+ <height>747</height>
</rect>
</property>
<property name="windowTitle">
@@ -31,23 +31,43 @@ QGroupBox:title {
<item>
<layout class="QVBoxLayout" name="verticalLayout">
<item>
- <widget class="FittingDataView" name="widget_data" native="true"/>
- </item>
- <item>
- <spacer name="verticalSpacer">
- <property name="orientation">
- <enum>Qt::Vertical</enum>
- </property>
- <property name="sizeType">
- <enum>QSizePolicy::MinimumExpanding</enum>
- </property>
- <property name="sizeHint" stdset="0">
- <size>
- <width>20</width>
- <height>0</height>
- </size>
+ <widget class="QScrollArea" name="scrollArea">
+ <property name="widgetResizable">
+ <bool>true</bool>
</property>
- </spacer>
+ <widget class="QWidget" name="scrollAreaWidgetContents">
+ <property name="geometry">
+ <rect>
+ <x>0</x>
+ <y>0</y>
+ <width>600</width>
+ <height>725</height>
+ </rect>
+ </property>
+ <layout class="QVBoxLayout" name="verticalLayout_3">
+ <item>
+ <widget class="FittingDataView" name="widget_data" native="true">
+ <property name="minimumSize">
+ <size>
+ <width>0</width>
+ <height>0</height>
+ </size>
+ </property>
+ </widget>
+ </item>
+ <item>
+ <widget class="FittingPlotView" name="widget_plot" native="true">
+ <property name="minimumSize">
+ <size>
+ <width>0</width>
+ <height>400</height>
+ </size>
+ </property>
+ </widget>
+ </item>
+ </layout>
+ </widget>
+ </widget>
</item>
</layout>
</item>
@@ -59,6 +79,12 @@ QGroupBox:title {
<extends>QWidget</extends>
<header>Engineering.gui.engineering_diffraction.tabs.fitting.data_handling.data_view</header>
</customwidget>
+ <customwidget>
+ <class>FittingPlotView</class>
+ <extends>QWidget</extends>
+ <header>Engineering.gui.engineering_diffraction.tabs.fitting.plotting.plot_view</header>
+ <container>1</container>
+ </customwidget>
</customwidgets>
<resources/>
<connections/>
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/__init__.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_model.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_model.py
new file mode 100644
index 0000000000000000000000000000000000000000..4f8ae77586e94c674b77c99c810cedbfe011f787
--- /dev/null
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_model.py
@@ -0,0 +1,31 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+
+class FittingPlotModel(object):
+ def __init__(self):
+ self.plotted_workspaces = set()
+
+ def get_plotted_workspaces(self):
+ return self.plotted_workspaces
+
+ def add_workspace_to_plot(self, ws, ax, plot_kwargs):
+ ax.plot(ws, **plot_kwargs)
+ self.plotted_workspaces.add(ws)
+
+ def remove_workspace_from_plot(self, ws, ax):
+ if ws in self.plotted_workspaces:
+ self._remove_workspace_from_plot(ws, ax)
+ self.plotted_workspaces.remove(ws)
+
+ @staticmethod
+ def _remove_workspace_from_plot(ws, ax):
+ ax.remove_workspace_artists(ws)
+
+ def remove_all_workspaces_from_plot(self, ax):
+ ax.cla()
+ self.plotted_workspaces.clear()
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_presenter.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_presenter.py
new file mode 100644
index 0000000000000000000000000000000000000000..5c5d04f08c84d4b61fcd73e7e248bcfb7c12e4e3
--- /dev/null
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_presenter.py
@@ -0,0 +1,44 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+from mantidqt.utils.observer_pattern import GenericObserverWithArgPassing, GenericObserver
+from Engineering.gui.engineering_diffraction.tabs.fitting.plotting.plot_model import FittingPlotModel
+from Engineering.gui.engineering_diffraction.tabs.fitting.plotting.plot_view import FittingPlotView
+
+PLOT_KWARGS = {"linestyle": "", "marker": "x", "markersize": "3"}
+
+
+class FittingPlotPresenter(object):
+ def __init__(self, parent, model=None, view=None):
+ if view is None:
+ self.view = FittingPlotView(parent)
+ else:
+ self.view = view
+ if model is None:
+ self.model = FittingPlotModel()
+ else:
+ self.model = model
+
+ self.workspace_added_observer = GenericObserverWithArgPassing(self.add_workspace_to_plot)
+ self.workspace_removed_observer = GenericObserverWithArgPassing(self.remove_workspace_from_plot)
+ self.all_workspaces_removed_observer = GenericObserver(self.clear_plot)
+
+ def add_workspace_to_plot(self, ws):
+ axes = self.view.get_axes()
+ for ax in axes:
+ self.model.add_workspace_to_plot(ws, ax, PLOT_KWARGS)
+ self.view.update_figure()
+
+ def remove_workspace_from_plot(self, ws):
+ for ax in self.view.get_axes():
+ self.model.remove_workspace_from_plot(ws, ax)
+ self.view.update_figure()
+
+ def clear_plot(self):
+ for ax in self.view.get_axes():
+ self.model.remove_all_workspaces_from_plot(ax)
+ self.view.clear_figure()
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_toolbar.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_toolbar.py
new file mode 100644
index 0000000000000000000000000000000000000000..94ea2ed78e170905e5f6e740f1aeee03d5c9aaa6
--- /dev/null
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_toolbar.py
@@ -0,0 +1,48 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+from matplotlib.backends.qt_compat import is_pyqt5
+from mantidqt.icons import get_icon
+from qtpy import QtWidgets, QtCore
+
+if is_pyqt5():
+ from matplotlib.backends.backend_qt5agg import NavigationToolbar2QT
+else:
+ from matplotlib.backends.backend_qt4agg import NavigationToolbar2QT
+
+
+class FittingPlotToolbar(NavigationToolbar2QT):
+ sig_home_clicked = QtCore.Signal()
+
+ toolitems = (
+ ('Home', 'Center display on contents', 'mdi.home', 'on_home_clicked', None),
+ ('Back', 'Back to previous view', 'mdi.arrow-left', 'back', None),
+ ('Forward', 'Forward to next view', 'mdi.arrow-right', 'forward', None),
+ (None, None, None, None, None),
+ ('Pan', 'Pan axes with left mouse, zoom with right', 'mdi.arrow-all', 'pan', False),
+ ('Zoom', 'Zoom to rectangle', 'mdi.magnify', 'zoom', False)
+ )
+
+ def _init_toolbar(self):
+ for text, tooltip_text, mdi_icon, callback, checked in self.toolitems:
+ if text is None:
+ self.addSeparator()
+ else:
+ action = self.addAction(get_icon(mdi_icon), text, getattr(self, callback))
+ self._actions[callback] = action
+ if checked is not None:
+ action.setCheckable(True)
+ action.setChecked(checked)
+ if tooltip_text is not None:
+ action.setToolTip(tooltip_text)
+
+ dpi_ratio = QtWidgets.QApplication.instance().desktop().physicalDpiX() / 100
+ self.setIconSize(QtCore.QSize(24 * dpi_ratio, 24 * dpi_ratio))
+
+ def on_home_clicked(self):
+ self.sig_home_clicked.emit()
+ self.push_current()
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_view.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_view.py
new file mode 100644
index 0000000000000000000000000000000000000000..598b090585f616a09d5bac2b890ab4314bf4578d
--- /dev/null
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_view.py
@@ -0,0 +1,88 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+from qtpy import QtWidgets
+
+from mantidqt.utils.qt import load_ui
+from matplotlib.figure import Figure
+from matplotlib.backends.qt_compat import is_pyqt5
+from Engineering.gui.engineering_diffraction.tabs.fitting.plotting.plot_toolbar import FittingPlotToolbar
+
+if is_pyqt5():
+ from matplotlib.backends.backend_qt5agg import FigureCanvas
+else:
+ from matplotlib.backends.backend_qt4agg import FigureCanvas
+
+Ui_plot, _ = load_ui(__file__, "plot_widget.ui")
+
+
+class FittingPlotView(QtWidgets.QWidget, Ui_plot):
+ def __init__(self, parent=None):
+ super(FittingPlotView, self).__init__(parent)
+ self.setupUi(self)
+
+ self.figure = None
+ self.toolbar = None
+
+ self.setup_figure()
+ self.setup_toolbar()
+
+ def setup_figure(self):
+ self.figure = Figure()
+ self.figure.canvas = FigureCanvas(self.figure)
+ self.figure.add_subplot(111, projection="mantid")
+ self.figure.tight_layout()
+ self.toolbar = FittingPlotToolbar(self.figure.canvas, self, False)
+ self.vLayout_plot.addWidget(self.toolbar)
+ self.vLayout_plot.addWidget(self.figure.canvas)
+
+ def resizeEvent(self, QResizeEvent):
+ self.figure.tight_layout()
+
+ def setup_toolbar(self):
+ self.toolbar.sig_home_clicked.connect(self.display_all)
+
+ # =================
+ # Component Setters
+ # =================
+
+ def clear_figure(self):
+ self.figure.clf()
+ self.figure.add_subplot(111, projection="mantid")
+ self.figure.tight_layout()
+ self.figure.canvas.draw()
+
+ def update_figure(self):
+ self.toolbar.update()
+ self.figure.tight_layout()
+ self.update_legend(self.get_axes()[0])
+ self.figure.canvas.draw()
+
+ def update_legend(self, ax):
+ if ax.get_lines():
+ ax.make_legend()
+ ax.get_legend().set_title("")
+ else:
+ if ax.get_legend():
+ ax.get_legend().remove()
+
+ def display_all(self):
+ for ax in self.get_axes():
+ if ax.lines:
+ ax.relim()
+ ax.autoscale()
+ self.update_figure()
+
+ # =================
+ # Component Getters
+ # =================
+
+ def get_axes(self):
+ return self.figure.axes
+
+ def get_figure(self):
+ return self.figure
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_widget.ui b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_widget.ui
new file mode 100644
index 0000000000000000000000000000000000000000..02e9e501ba28f5d514a095a83f0a4a804d354ad8
--- /dev/null
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/plot_widget.ui
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Form</class>
+ <widget class="QWidget" name="Form">
+ <property name="geometry">
+ <rect>
+ <x>0</x>
+ <y>0</y>
+ <width>602</width>
+ <height>514</height>
+ </rect>
+ </property>
+ <property name="windowTitle">
+ <string>Form</string>
+ </property>
+ <property name="styleSheet">
+ <string notr="true">QGroupBox {
+border: 1px solid grey;border-radius: 10px;margin-top: 1ex; margin-right: 0ex
+}
+QGroupBox:title {
+ subcontrol-origin: margin;
+ padding: 0 3px;
+ subcontrol-position: top center;
+ padding-top: 0px;
+ padding-bottom: 0px;
+ padding-right: 10px;
+ color: rgb(56, 56, 56)
+}</string>
+ </property>
+ <layout class="QGridLayout" name="gridLayout">
+ <property name="leftMargin">
+ <number>0</number>
+ </property>
+ <property name="topMargin">
+ <number>0</number>
+ </property>
+ <property name="rightMargin">
+ <number>0</number>
+ </property>
+ <property name="bottomMargin">
+ <number>0</number>
+ </property>
+ <item row="0" column="0">
+ <layout class="QVBoxLayout" name="vLayout_widget">
+ <item>
+ <widget class="QGroupBox" name="group_plot">
+ <property name="title">
+ <string>Plot</string>
+ </property>
+ <layout class="QGridLayout" name="gridLayout_2">
+ <item row="0" column="0">
+ <layout class="QVBoxLayout" name="vLayout_plot"/>
+ </item>
+ </layout>
+ </widget>
+ </item>
+ </layout>
+ </item>
+ </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/test/__init__.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/test/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/test/test_plot_model.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/test/test_plot_model.py
new file mode 100644
index 0000000000000000000000000000000000000000..32c7aa275bce61ea993bf7b29365c8a42fa89711
--- /dev/null
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/test/test_plot_model.py
@@ -0,0 +1,59 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+import unittest
+
+from mantid.py3compat import mock
+
+from Engineering.gui.engineering_diffraction.tabs.fitting.plotting import plot_model
+
+dir_path = "Engineering.gui.engineering_diffraction.tabs.fitting.plotting"
+
+
+class FittingPlotModelTest(unittest.TestCase):
+ def setUp(self):
+ self.model = plot_model.FittingPlotModel()
+
+ def test_adding_workspace_to_plot(self):
+ self.assertEqual(set(), self.model.plotted_workspaces)
+ ax = mock.MagicMock()
+
+ self.model.add_workspace_to_plot("mocked_ws", ax, {"linestyle": "x"})
+
+ self.assertEqual({"mocked_ws"}, self.model.plotted_workspaces)
+ ax.plot.assert_called_once_with("mocked_ws", linestyle="x")
+
+ def test_removing_single_tracked_workspace_from_plot(self):
+ self.model.plotted_workspaces.add("mocked_ws")
+ ax = mock.MagicMock()
+
+ self.model.remove_workspace_from_plot("mocked_ws", ax)
+
+ self.assertEqual(set(), self.model.plotted_workspaces)
+ ax.remove_workspace_artists.assert_called_once_with("mocked_ws")
+
+ def test_removing_not_tracked_workspace_from_plot(self):
+ self.model.plotted_workspaces.add("mocked_ws")
+ ax = mock.MagicMock()
+
+ self.model.remove_workspace_from_plot("whatever", ax)
+
+ self.assertEqual({"mocked_ws"}, self.model.plotted_workspaces)
+ ax.remove_workspace_artists.assert_not_called()
+
+ def test_removing_all_workspaces_from_plot(self):
+ self.model.plotted_workspaces.update({"mocked_ws", "mock_ws_2"})
+ ax = mock.MagicMock()
+
+ self.model.remove_all_workspaces_from_plot(ax)
+
+ self.assertEqual(set(), self.model.plotted_workspaces)
+ self.assertEqual(1, ax.cla.call_count)
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/test/test_plot_presenter.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/test/test_plot_presenter.py
new file mode 100644
index 0000000000000000000000000000000000000000..d3044a30583c49f0437b11c7a725053df3d43261
--- /dev/null
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/plotting/test/test_plot_presenter.py
@@ -0,0 +1,55 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+import unittest
+
+from mantid.py3compat import mock
+
+from Engineering.gui.engineering_diffraction.tabs.fitting.plotting import plot_model, plot_view, plot_presenter
+
+dir_path = "Engineering.gui.engineering_diffraction.tabs.fitting.plotting"
+
+
+class FittingPlotPresenterTest(unittest.TestCase):
+ def setUp(self):
+ self.model = mock.create_autospec(plot_model.FittingPlotModel)
+ self.view = mock.create_autospec(plot_view.FittingPlotView)
+ self.presenter = plot_presenter.FittingPlotPresenter(None, self.model, self.view)
+
+ def test_add_workspace_to_plot(self):
+ self.view.get_axes.return_value = ["axis1", "axis2"]
+
+ self.presenter.add_workspace_to_plot("workspace")
+
+ self.assertEqual(1, self.view.update_figure.call_count)
+ self.assertEqual(2, self.model.add_workspace_to_plot.call_count)
+ self.model.add_workspace_to_plot.assert_any_call("workspace", "axis1", plot_presenter.PLOT_KWARGS)
+ self.model.add_workspace_to_plot.assert_any_call("workspace", "axis2", plot_presenter.PLOT_KWARGS)
+
+ def test_remove_workspace_from_plot(self):
+ self.view.get_axes.return_value = ["axis1", "axis2"]
+
+ self.presenter.remove_workspace_from_plot("workspace")
+
+ self.assertEqual(1, self.view.update_figure.call_count)
+ self.assertEqual(2, self.model.remove_workspace_from_plot.call_count)
+ self.model.remove_workspace_from_plot.assert_any_call("workspace", "axis1")
+ self.model.remove_workspace_from_plot.assert_any_call("workspace", "axis2")
+
+ def test_clear_plot(self):
+ self.view.get_axes.return_value = ["axis1", "axis2"]
+
+ self.presenter.clear_plot()
+
+ self.assertEqual(1, self.view.clear_figure.call_count)
+ self.assertEqual(2, self.model.remove_all_workspaces_from_plot.call_count)
+ self.model.remove_all_workspaces_from_plot.assert_any_call("axis1")
+ self.model.remove_all_workspaces_from_plot.assert_any_call("axis2")
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/presenter.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/presenter.py
index a52ce0f7e764b2411a82e32c27b9f0fd10694563..b4d7f649a9d4c67ee3d453ffad27d9dd07128e86 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/presenter.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/presenter.py
@@ -6,6 +6,7 @@
# SPDX - License - Identifier: GPL - 3.0 +
from Engineering.gui.engineering_diffraction.tabs.fitting.data_handling.data_widget import FittingDataWidget
+from Engineering.gui.engineering_diffraction.tabs.fitting.plotting.plot_presenter import FittingPlotPresenter
class FittingPresenter(object):
@@ -13,3 +14,11 @@ class FittingPresenter(object):
self.view = view
self.data_widget = FittingDataWidget(self.view, view=self.view.get_data_widget())
+ self.plot_widget = FittingPlotPresenter(self.view, view=self.view.get_plot_widget())
+
+ self.data_widget.presenter.plot_removed_notifier.add_subscriber(
+ self.plot_widget.workspace_removed_observer)
+ self.data_widget.presenter.plot_added_notifier.add_subscriber(
+ self.plot_widget.workspace_added_observer)
+ self.data_widget.presenter.all_plots_removed_notifier.add_subscriber(
+ self.plot_widget.all_workspaces_removed_observer)
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/view.py b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/view.py
index ed2682d910c3a063d59c855a3a840c7725dc03aa..64bfced0b12c60a77da33bcbfe62174b64f86518 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/view.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/fitting/view.py
@@ -19,3 +19,6 @@ class FittingView(QtWidgets.QWidget, Ui_fitting):
def get_data_widget(self):
return self.widget_data
+
+ def get_plot_widget(self):
+ return self.widget_plot
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/model.py b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/model.py
index 80575eceb9daae211eb64787c7514bc576f3659c..4de9cd41ccf365d00250266c8ae47e8a6ee430d4 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/model.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/model.py
@@ -21,10 +21,10 @@ FOCUSED_OUTPUT_WORKSPACE_NAME = "engggui_focusing_output_ws_bank_"
class FocusModel(object):
- def focus_run(self, sample_path, banks, plot_output, instrument, rb_num, spectrum_numbers):
+ def focus_run(self, sample_paths, banks, plot_output, instrument, rb_num, spectrum_numbers):
"""
Focus some data using the current calibration.
- :param sample_path: The path to the data to be focused.
+ :param sample_paths: The paths to the data to be focused.
:param banks: The banks that should be focused.
:param plot_output: True if the output should be plotted.
:param instrument: The instrument that the data came from.
@@ -36,8 +36,7 @@ class FocusModel(object):
return
integration_workspace = Ads.retrieve(vanadium_corrections.INTEGRATED_WORKSPACE_NAME)
curves_workspace = Ads.retrieve(vanadium_corrections.CURVES_WORKSPACE_NAME)
- sample_workspace = path_handling.load_workspace(sample_path)
- output_workspaces = []
+ output_workspaces = [] # List of collated workspaces to plot.
full_calib_path = get_setting(path_handling.INTERFACES_SETTINGS_GROUP,
path_handling.ENGINEERING_PREFIX, "full_calibration")
if full_calib_path is not None and path.exists(full_calib_path):
@@ -45,22 +44,31 @@ class FocusModel(object):
else:
full_calib_workspace = None
if spectrum_numbers is None:
- for name in banks:
- output_workspace_name = FOCUSED_OUTPUT_WORKSPACE_NAME + str(name)
- self._run_focus(sample_workspace, output_workspace_name, integration_workspace,
- curves_workspace, name, full_calib_workspace)
- output_workspaces.append(output_workspace_name)
- # Save the output to the file system.
- self._save_output(instrument, sample_path, name, output_workspace_name, rb_num)
+ for sample_path in sample_paths:
+ sample_workspace = path_handling.load_workspace(sample_path)
+ run_no = path_handling.get_run_number_from_path(sample_path, instrument)
+ workspaces_for_run = []
+ for name in banks:
+ output_workspace_name = str(run_no) + "_" + FOCUSED_OUTPUT_WORKSPACE_NAME + str(name)
+ self._run_focus(sample_workspace, output_workspace_name, integration_workspace,
+ curves_workspace, name, full_calib_workspace)
+ workspaces_for_run.append(output_workspace_name)
+ # Save the output to the file system.
+ self._save_output(instrument, sample_path, name, output_workspace_name, rb_num)
+ output_workspaces.append(workspaces_for_run)
else:
- output_workspace_name = FOCUSED_OUTPUT_WORKSPACE_NAME + "cropped"
- self._run_focus(sample_workspace, output_workspace_name, integration_workspace,
- curves_workspace, None, full_calib_workspace, spectrum_numbers)
- output_workspaces.append(output_workspace_name)
- self._save_output(instrument, sample_path, "cropped", output_workspace_name, rb_num)
+ for sample_path in sample_paths:
+ sample_workspace = path_handling.load_workspace(sample_path)
+ run_no = path_handling.get_run_number_from_path(sample_path, instrument)
+ output_workspace_name = str(run_no) + "_" + FOCUSED_OUTPUT_WORKSPACE_NAME + "cropped"
+ self._run_focus(sample_workspace, output_workspace_name, integration_workspace,
+ curves_workspace, None, full_calib_workspace, spectrum_numbers)
+ output_workspaces.append([output_workspace_name])
+ self._save_output(instrument, sample_path, "cropped", output_workspace_name, rb_num)
# Plot the output
if plot_output:
- self._plot_focused_workspaces(output_workspaces)
+ for ws_names in output_workspaces:
+ self._plot_focused_workspaces(ws_names)
@staticmethod
def _run_focus(input_workspace,
@@ -128,7 +136,7 @@ class FocusModel(object):
path_handling.get_output_path(), "Focus",
self._generate_output_file_name(instrument, sample_path, bank, ".gss"))
SaveGSS(InputWorkspace=sample_workspace, Filename=gss_output_path)
- if rb_num is not None:
+ if rb_num:
gss_output_path = path.join(
path_handling.get_output_path(), "User", rb_num, "Focus",
self._generate_output_file_name(instrument, sample_path, bank, ".gss"))
@@ -140,7 +148,7 @@ class FocusModel(object):
path_handling.get_output_path(), "Focus",
self._generate_output_file_name(instrument, sample_path, bank, ".nxs"))
SaveNexus(InputWorkspace=sample_workspace, Filename=nexus_output_path)
- if rb_num is not None:
+ if rb_num:
nexus_output_path = path.join(
path_handling.get_output_path(), "User", rb_num, "Focus",
self._generate_output_file_name(instrument, sample_path, bank, ".nxs"))
@@ -152,7 +160,7 @@ class FocusModel(object):
path_handling.get_output_path(), "Focus",
self._generate_output_file_name(instrument, sample_path, bank, ".dat"))
SaveFocusedXYE(InputWorkspace=sample_workspace, Filename=xye_output_path, SplitFiles=False)
- if rb_num is not None:
+ if rb_num:
xye_output_path = path.join(
path_handling.get_output_path(), "User", rb_num, "Focus",
self._generate_output_file_name(instrument, sample_path, bank, ".dat"))
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/presenter.py b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/presenter.py
index 8a9bad5d4bfa4759948cec671bf322f195d854b5..37e3f94b1c6d62c054946fa5426aed3832c34b63 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/presenter.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/presenter.py
@@ -14,6 +14,8 @@ from Engineering.gui.engineering_diffraction.tabs.common.cropping.cropping_widge
from mantidqt.utils.asynchronous import AsyncTask
from mantidqt.utils.observer_pattern import Observer
+from qtpy.QtWidgets import QMessageBox
+
class FocusPresenter(object):
def __init__(self, model, view):
@@ -40,20 +42,21 @@ class FocusPresenter(object):
if not self._validate():
return
banks, spectrum_numbers = self._get_banks()
- focus_path = self.view.get_focus_filename()
- self.start_focus_worker(focus_path, banks, self.view.get_plot_output(), self.rb_num, spectrum_numbers)
+ focus_paths = self.view.get_focus_filenames()
+ if self._number_of_files_warning(focus_paths):
+ self.start_focus_worker(focus_paths, banks, self.view.get_plot_output(), self.rb_num, spectrum_numbers)
- def start_focus_worker(self, focus_path, banks, plot_output, rb_num, spectrum_numbers=None):
+ def start_focus_worker(self, focus_paths, banks, plot_output, rb_num, spectrum_numbers=None):
"""
Focus data in a separate thread to stop the main GUI from hanging.
- :param focus_path: The path to the file containing the data to focus.
+ :param focus_paths: List of paths to the files containing the data to focus.
:param banks: A list of banks that are to be focused.
:param plot_output: True if the output should be plotted.
:param rb_num: The RB Number from the main window (often an experiment id)
:param spectrum_numbers: Optional parameter to crop to a specific list of spectrum numbers.
"""
self.worker = AsyncTask(self.model.focus_run,
- (focus_path, banks, plot_output, self.instrument, rb_num, spectrum_numbers),
+ (focus_paths, banks, plot_output, self.instrument, rb_num, spectrum_numbers),
error_cb=self._on_worker_error,
finished_cb=self.emit_enable_button_signal)
self.set_focus_controls_enabled(False)
@@ -94,6 +97,16 @@ class FocusPresenter(object):
return False
return True
+ def _number_of_files_warning(self, paths):
+ if len(paths) > 10: # Just a guess on the warning for now. May change in future.
+ response = QMessageBox.warning(
+ self.view, 'Engineering Diffraction - Warning',
+ 'You are attempting to focus {} workspaces. This may take some time.\n\n Would you like to continue?'
+ .format(len(paths)), QMessageBox.Ok | QMessageBox.Cancel)
+ return response == QMessageBox.Ok
+ else:
+ return True
+
def _on_worker_error(self, _):
self.emit_enable_button_signal()
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/test/test_focus_model.py b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/test/test_focus_model.py
index 99a1d3aa44ae8d429b3525c0a4567e68f078888c..5698ddd9fa3d7fa764cb15b1b8965bc5bcca37da 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/test/test_focus_model.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/test/test_focus_model.py
@@ -41,11 +41,12 @@ class FocusModelTest(unittest.TestCase):
banks = ["1", "2"]
load_focus.return_value = "mocked_sample"
- self.model.focus_run("305761", banks, False, "ENGINX", "0", None)
+ self.model.focus_run(["305761"], banks, False, "ENGINX", "0", None)
+
self.assertEqual(len(banks), run_focus.call_count)
run_focus.assert_called_with("mocked_sample",
- model.FOCUSED_OUTPUT_WORKSPACE_NAME + banks[-1], "test_wsp",
- "test_wsp", banks[-1], None)
+ "305761_" + model.FOCUSED_OUTPUT_WORKSPACE_NAME + banks[-1],
+ "test_wsp", "test_wsp", banks[-1], None)
@patch(file_path + ".Ads")
@patch(file_path + ".FocusModel._save_output")
@@ -56,11 +57,12 @@ class FocusModelTest(unittest.TestCase):
spectra = "20-50"
load_focus.return_value = "mocked_sample"
- self.model.focus_run("305761", None, False, "ENGINX", "0", spectra)
+ self.model.focus_run(["305761"], None, False, "ENGINX", "0", spectra)
+
self.assertEqual(1, run_focus.call_count)
run_focus.assert_called_with("mocked_sample",
- model.FOCUSED_OUTPUT_WORKSPACE_NAME + "cropped", "test_wsp",
- "test_wsp", None, None, spectra)
+ "305761_" + model.FOCUSED_OUTPUT_WORKSPACE_NAME + "cropped",
+ "test_wsp", "test_wsp", None, None, spectra)
@patch(file_path + ".Ads")
@patch(file_path + ".FocusModel._save_output")
@@ -75,7 +77,8 @@ class FocusModelTest(unittest.TestCase):
banks = ["1", "2"]
load_focus.return_value = "mocked_sample"
- self.model.focus_run("305761", banks, True, "ENGINX", "0", None)
+ self.model.focus_run(["305761"], banks, True, "ENGINX", "0", None)
+
self.assertEqual(1, plot_focus.call_count)
@patch(file_path + ".Ads")
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/test/test_focus_presenter.py b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/test/test_focus_presenter.py
index 4ced5e5601aa5235764cd90f465ae2dd444b5492..1e8458de003b6d40919f75e3be18c0eb5be7a742 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/test/test_focus_presenter.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/test/test_focus_presenter.py
@@ -30,7 +30,7 @@ class FocusPresenterTest(unittest.TestCase):
self.presenter.current_calibration = CalibrationInfo(vanadium_path="Fake/Path",
sample_path="Fake/Path",
instrument="ENGINX")
- self.view.get_focus_filename.return_value = "305738"
+ self.view.get_focus_filenames.return_value = "305738"
self.presenter.cropping_widget.get_bank.return_value = "2"
self.presenter.cropping_widget.is_custom.return_value = False
self.view.get_plot_output.return_value = True
@@ -46,7 +46,7 @@ class FocusPresenterTest(unittest.TestCase):
self.presenter.current_calibration = CalibrationInfo(vanadium_path="Fake/Path",
sample_path="Fake/Path",
instrument="ENGINX")
- self.view.get_focus_filename.return_value = "305738"
+ self.view.get_focus_filenames.return_value = "305738"
self.presenter.cropping_widget.get_custom_spectra.return_value = "2-45"
self.view.get_plot_output.return_value = True
self.view.is_searching.return_value = False
diff --git a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/view.py b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/view.py
index c05c51e041c409c8a30cbaddf2254e9bf9108c5c..078b312d859ffedb166780bdd9be9d504e2d20f0 100644
--- a/scripts/Engineering/gui/engineering_diffraction/tabs/focus/view.py
+++ b/scripts/Engineering/gui/engineering_diffraction/tabs/focus/view.py
@@ -23,6 +23,7 @@ class FocusView(QtWidgets.QWidget, Ui_focus):
self.finder_focus.setLabelText("Sample Run #")
self.finder_focus.setInstrumentOverride(instrument)
+ self.finder_focus.allowMultipleFiles(True)
# =================
# Slot Connectors
@@ -57,8 +58,8 @@ class FocusView(QtWidgets.QWidget, Ui_focus):
# Component Getters
# =================
- def get_focus_filename(self):
- return self.finder_focus.getFirstFilename()
+ def get_focus_filenames(self):
+ return self.finder_focus.getFilenames()
def get_focus_valid(self):
return self.finder_focus.isValid()
diff --git a/scripts/ISIS_Reflectometry_Old.py b/scripts/ISIS_Reflectometry_Old.py
deleted file mode 100644
index 9d1a4a4cadee05325d21eac9091047576eb25312..0000000000000000000000000000000000000000
--- a/scripts/ISIS_Reflectometry_Old.py
+++ /dev/null
@@ -1,16 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-#pylint: disable=invalid-name
-"""
- Script used to start the ISIS Reflectomery GUI from MantidPlot
-"""
-from __future__ import (absolute_import, division, print_function)
-from ui.reflectometer import refl_gui
-
-ui = refl_gui.ReflGui()
-if ui.setup_layout():
- ui.show()
diff --git a/scripts/Inelastic/CrystalField/fitting.py b/scripts/Inelastic/CrystalField/fitting.py
index 1e07623f53c0d7a0860616e7d582986986adcc9c..43f54d20c9d891a498006c2e021632f07304867d 100644
--- a/scripts/Inelastic/CrystalField/fitting.py
+++ b/scripts/Inelastic/CrystalField/fitting.py
@@ -59,7 +59,7 @@ def cfpstrmaker(x, pref='B'):
def getSymmAllowedParam(sym_str):
if 'T' in sym_str or 'O' in sym_str:
- return ['B40', 'B44', 'B60', 'B64']
+ return ['B40', 'B60']
if any([sym_str == val for val in ['C1', 'Ci']]):
return sum([cfpstrmaker(i) for i in range(7)] +
[cfpstrmaker(i, 'IB') for i in range(1, 7)],[])
@@ -214,10 +214,15 @@ class CrystalField(object):
elif key not in free_parameters:
raise RuntimeError('Unknown attribute/parameters %s' % key)
+ # Cubic is a special case where B44=5*B40, B64=-21*B60
+ is_cubic = self.Symmetry.startswith('T') or self.Symmetry.startswith('O')
+ symm_allowed_par = getSymmAllowedParam(self.Symmetry)
+
for param in CrystalField.field_parameter_names:
if param in free_parameters:
self.function.setParameter(param, free_parameters[param])
- symm_allowed_par = getSymmAllowedParam(self.Symmetry)
+ if is_cubic and (param == 'B44' or param == 'B64'):
+ continue
if param not in symm_allowed_par:
self.function.fixParameter(param)
else:
@@ -1087,7 +1092,7 @@ class CrystalField(object):
def _getFieldTies(self):
ties = re.search(',ties=\((.*?)\)', str(self.crystalFieldFunction))
- return ties.group(1) if ties else ''
+ return re.sub(FN_PATTERN, '', ties.group(1)).rstrip(',') if ties else ''
def _getFieldConstraints(self):
constraints = re.search('constraints=\((.*?)\)', str(self.crystalFieldFunction))
diff --git a/scripts/Interface/ui/CMakeLists.txt b/scripts/Interface/ui/CMakeLists.txt
index 2848db2576f9214feb8e369d6f1bb3144c327bef..b92fbcab5b69a5e1fb39e2ef6288dfff65b6a077 100644
--- a/scripts/Interface/ui/CMakeLists.txt
+++ b/scripts/Interface/ui/CMakeLists.txt
@@ -1,5 +1,4 @@
include(UiToPy)
-add_subdirectory(reflectometer)
add_subdirectory(dataprocessorinterface)
add_subdirectory(batchwidget)
add_subdirectory(poldi)
@@ -11,7 +10,6 @@ UiToPy(UI_FILES CompileUIUIBase)
add_custom_target(CompileUIUI
DEPENDS CompileUIUIBase
- CompileUIReflectometer
CompileUIDataProcessorInterface
CompileUIBatchWidgetInterface
CompileUIPoldi)
@@ -19,7 +17,6 @@ add_custom_target(CompileUIUI
# Put all ui targets inside the 'CompilePyUI' folder or group in VS and the
# like, for convenience
set_property(TARGET CompileUIUIBase PROPERTY FOLDER "CompilePyUI")
-set_property(TARGET CompileUIReflectometer PROPERTY FOLDER "CompilePyUI")
set_property(TARGET CompileUIDataProcessorInterface
PROPERTY FOLDER "CompilePyUI")
set_property(TARGET CompileUIPoldi PROPERTY FOLDER "CompilePyUI")
diff --git a/scripts/Interface/ui/reflectometer/CMakeLists.txt b/scripts/Interface/ui/reflectometer/CMakeLists.txt
deleted file mode 100644
index c9e00afe6536ecaf0df266d1e6f04f479c996aa8..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/CMakeLists.txt
+++ /dev/null
@@ -1,7 +0,0 @@
-# List of UIs to Auto convert
-set(UI_FILES
- refl_columns.ui
- refl_options_window.ui
- refl_window.ui)
-
-UiToPy(UI_FILES CompileUIReflectometer)
diff --git a/scripts/Interface/ui/reflectometer/refl_choose_col.py b/scripts/Interface/ui/reflectometer/refl_choose_col.py
deleted file mode 100644
index adcf3da8f498715a2f3facaba609a45e4cc4422f..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/refl_choose_col.py
+++ /dev/null
@@ -1,51 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-#pylint: disable=invalid-name
-#This is an extension of refl_columns.py as that is a auto-generated script form pyqt and shouldn't be edited
-#so this file provides any extra GUI tweaks not easily doable in the designer
-#for the time being this also includes non-GUI behaviour
-from __future__ import (absolute_import, division, print_function)
-from PyQt4 import QtCore, QtGui
-from ui.reflectometer.ui_refl_columns import Ui_chooseColumnsDialog
-
-try:
- _fromUtf8 = QtCore.QString.fromUtf8
-except AttributeError:
- def _fromUtf8(s):
- return s
-
-
-class ReflChoose(QtGui.QDialog, Ui_chooseColumnsDialog):
-
- visiblestates = {}
-
- def __init__(self, col_headers, table):
- """
- Initialise the interface
- """
- super(QtGui.QDialog, self).__init__()
- self.setupUi(self)
- self.visiblestates.clear()
- self.listColumns.itemChanged.connect(self.on_listColumns_itemChanged)
- self.buttonsColumns.clicked.connect(self.on_buttonsColumns_Clicked)
- for key, value in col_headers.iteritems():
- header = table.horizontalHeaderItem(key).text()
- item = QtGui.QListWidgetItem(header)
- if value:
- item.setCheckState(2)
- else:
- item.setCheckState(0)
- self.listColumns.insertItem(key, item)
-
- def on_listColumns_itemChanged(self, item):
- colno=self.listColumns.row(item)
- self.visiblestates[colno] = (item.checkState() > 0)
-
- def on_buttonsColumns_Clicked(self, button):
- if self.buttonsColumns.button(QtGui.QDialogButtonBox.RestoreDefaults) == button:
- for i in range(self.listColumns.count()):
- self.listColumns.item(i).setCheckState(2)
diff --git a/scripts/Interface/ui/reflectometer/refl_columns.ui b/scripts/Interface/ui/reflectometer/refl_columns.ui
deleted file mode 100644
index 7977dbcde6f572f837a9b0d3018402109f33deeb..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/refl_columns.ui
+++ /dev/null
@@ -1,100 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>chooseColumnsDialog</class>
- <widget class="QDialog" name="chooseColumnsDialog">
- <property name="geometry">
- <rect>
- <x>0</x>
- <y>0</y>
- <width>307</width>
- <height>300</height>
- </rect>
- </property>
- <property name="windowTitle">
- <string>Choose Columns...</string>
- </property>
- <property name="sizeGripEnabled">
- <bool>false</bool>
- </property>
- <layout class="QVBoxLayout" name="verticalLayout">
- <item>
- <widget class="QLabel" name="labelColumns">
- <property name="text">
- <string>Choose columns to display</string>
- </property>
- </widget>
- </item>
- <item>
- <layout class="QHBoxLayout" name="layoutListButtons">
- <item>
- <widget class="QListWidget" name="listColumns">
- <property name="editTriggers">
- <set>QAbstractItemView::NoEditTriggers</set>
- </property>
- <property name="selectionMode">
- <enum>QAbstractItemView::NoSelection</enum>
- </property>
- </widget>
- </item>
- <item>
- <widget class="QDialogButtonBox" name="buttonsColumns">
- <property name="sizePolicy">
- <sizepolicy hsizetype="Fixed" vsizetype="Expanding">
- <horstretch>0</horstretch>
- <verstretch>0</verstretch>
- </sizepolicy>
- </property>
- <property name="layoutDirection">
- <enum>Qt::LeftToRight</enum>
- </property>
- <property name="orientation">
- <enum>Qt::Vertical</enum>
- </property>
- <property name="standardButtons">
- <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok|QDialogButtonBox::RestoreDefaults</set>
- </property>
- <property name="centerButtons">
- <bool>false</bool>
- </property>
- </widget>
- </item>
- </layout>
- </item>
- </layout>
- </widget>
- <resources/>
- <connections>
- <connection>
- <sender>buttonsColumns</sender>
- <signal>accepted()</signal>
- <receiver>chooseColumnsDialog</receiver>
- <slot>accept()</slot>
- <hints>
- <hint type="sourcelabel">
- <x>248</x>
- <y>254</y>
- </hint>
- <hint type="destinationlabel">
- <x>157</x>
- <y>274</y>
- </hint>
- </hints>
- </connection>
- <connection>
- <sender>buttonsColumns</sender>
- <signal>rejected()</signal>
- <receiver>chooseColumnsDialog</receiver>
- <slot>reject()</slot>
- <hints>
- <hint type="sourcelabel">
- <x>316</x>
- <y>260</y>
- </hint>
- <hint type="destinationlabel">
- <x>286</x>
- <y>274</y>
- </hint>
- </hints>
- </connection>
- </connections>
-</ui>
diff --git a/scripts/Interface/ui/reflectometer/refl_gui.py b/scripts/Interface/ui/reflectometer/refl_gui.py
deleted file mode 100644
index 2a837e18b4234dbe8ec112a51b5b3f636ec09b41..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/refl_gui.py
+++ /dev/null
@@ -1,1455 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-# pylint: disable = too-many-lines, invalid-name, line-too-long, too-many-instance-attributes,
-# pylint: disable = too-many-branches,too-many-locals, too-many-nested-blocks
-from __future__ import (absolute_import, division, print_function)
-
-try:
- from mantidplot import *
-except ImportError:
- canMantidPlot = False #
-
-import csv
-import os
-import re
-from operator import itemgetter
-import itertools
-from PyQt4 import QtCore, QtGui
-from mantid.simpleapi import *
-from isis_reflectometry.quick import *
-from isis_reflectometry.convert_to_wavelength import ConvertToWavelength
-from isis_reflectometry import load_live_runs
-from isis_reflectometry.combineMulti import *
-import mantidqtpython
-from mantid.api import Workspace, WorkspaceGroup, CatalogManager, AlgorithmManager
-from mantid.kernel import UsageService, FeatureType
-from mantid import logger
-
-from ui.reflectometer.ui_refl_window import Ui_windowRefl
-from ui.reflectometer.refl_save import Ui_SaveWindow
-from ui.reflectometer.refl_choose_col import ReflChoose
-from ui.reflectometer.refl_options import ReflOptions
-
-try:
- _fromUtf8 = QtCore.QString.fromUtf8
-except AttributeError:
- def _fromUtf8(s):
- return s
-
-canMantidPlot = True
-
-
-class ReflGui(QtGui.QMainWindow, Ui_windowRefl):
- current_instrument = None
- current_table = None
- current_polarisation_method = None
- labelStatus = None
- accMethod = None
-
- def show_deprecation_warning(self):
- logger.warning("""
-The ISIS Reflectometry (Old) interface has been deprecated and will be removed from Mantid in November 2019
-We recommend you use ISIS Reflectometry instead, If this is not possible contact the development team using the "Help->Ask For Help" menu.
-""")
-
- def __init__(self):
- """
- Initialise the interface
- """
- super(QtGui.QMainWindow, self).__init__()
- self.setupUi(self)
- self.show_deprecation_warning()
- self.loading = False
- self.clip = QtGui.QApplication.clipboard()
- self.shown_cols = {}
- self.mod_flag = False
- self.run_cols = [0, 5, 10]
- self.angle_cols = [1, 6, 11]
- self.scale_col = 16
- self.stitch_col = 17
- self.plot_col = 18
-
- self.__graphs = dict()
-
- self._last_trans = ""
- self.icat_file_map = None
-
- self.__instrumentRuns = None
-
- self.__icat_download = False
- self.__group_tof_workspaces = True
-
- # Q Settings
- self.__generic_settings = "Mantid/ISISReflGui"
- self.__live_data_settings = "Mantid/ISISReflGui/LiveData"
- self.__search_settings = "Mantid/ISISReflGui/Search"
- self.__column_settings = "Mantid/ISISReflGui/Columns"
- self.__icat_download_key = "icat_download"
- self.__ads_use_key = "AlgUse"
- self.__alg_migration_key = "AlgUseReset"
- self.__live_data_frequency_key = "frequency"
- self.__live_data_method_key = "method"
- self.__group_tof_workspaces_key = "group_tof_workspaces"
- self.__stitch_right_key = "stitch_right"
-
- # Setup instrument with defaults assigned.
- self.instrument_list = ['INTER', 'SURF', 'CRISP', 'POLREF', 'OFFSPEC']
- self.polarisation_instruments = ['CRISP', 'POLREF']
- self.polarisation_options = {'None': PolarisationCorrection.NONE,
- '1-PNR': PolarisationCorrection.PNR,
- '2-PA': PolarisationCorrection.PA}
-
- # Set the live data settings, use default if none have been set before
- settings = QtCore.QSettings()
- settings.beginGroup(self.__live_data_settings)
- self.live_method = settings.value(self.__live_data_method_key, "", type=str)
- self.live_freq = settings.value(self.__live_data_frequency_key, 0, type=float)
-
- if not self.live_freq:
- logger.information(
- "No settings were found for Update frequency of loading live data, Loading default of 60 seconds")
- self.live_freq = float(60)
- settings.setValue(self.__live_data_frequency_key, self.live_freq)
- if not self.live_method:
- logger.information(
- "No settings were found for Accumulation Method of loading live data, Loading default of \"Add\"")
- self.live_method = "Add"
- settings.setValue(self.__live_data_method_key, self.live_method)
- settings.endGroup()
-
- settings.beginGroup(self.__generic_settings)
-
- self.__alg_migrate = settings.value(self.__alg_migration_key, True, type=bool)
- if self.__alg_migrate:
- self.__alg_use = True # We will use the algorithms by default rather than the quick scripts
- self.__alg_migrate = False # Never do this again. We only want to reset once.
- else:
- self.__alg_use = settings.value(self.__ads_use_key, True, type=bool)
-
- self.__icat_download = settings.value(self.__icat_download_key, False, type=bool)
- self.__group_tof_workspaces = settings.value(self.__group_tof_workspaces_key, True, type=bool)
- self.__scale_right = settings.value(self.__stitch_right_key, True, type=bool)
-
- settings.setValue(self.__ads_use_key, self.__alg_use)
- settings.setValue(self.__icat_download_key, self.__icat_download)
- settings.setValue(self.__group_tof_workspaces_key, self.__group_tof_workspaces)
- settings.setValue(self.__alg_migration_key, self.__alg_migrate)
- settings.setValue(self.__stitch_right_key, self.__scale_right)
-
- settings.endGroup()
-
- del settings
- # register startup
- UsageService.registerFeatureUsage(FeatureType.Interface, "ISIS Reflectomety", False)
-
- def __del__(self):
- """
- Save the contents of the table if the modified flag was still set
- """
- if self.mod_flag:
- self._save(true)
-
- def _save_check(self):
- """
- Show a custom message box asking if the user wants to save, or discard their changes or cancel back to the interface
- """
- msgBox = QtGui.QMessageBox()
- msgBox.setText("The table has been modified. Do you want to save your changes?")
-
- accept_btn = QtGui.QPushButton('Save')
- cancel_btn = QtGui.QPushButton('Cancel')
- discard_btn = QtGui.QPushButton('Discard')
-
- msgBox.addButton(accept_btn, QtGui.QMessageBox.AcceptRole)
- msgBox.addButton(cancel_btn, QtGui.QMessageBox.RejectRole)
- msgBox.addButton(discard_btn, QtGui.QMessageBox.NoRole)
-
- msgBox.setIcon(QtGui.QMessageBox.Question)
- msgBox.setDefaultButton(accept_btn)
- msgBox.setEscapeButton(cancel_btn)
- msgBox.exec_()
- btn = msgBox.clickedButton()
- saved = None
- if btn.text() == accept_btn.text():
- ret = QtGui.QMessageBox.AcceptRole
- saved = self._save()
- elif btn.text() == cancel_btn.text():
- ret = QtGui.QMessageBox.RejectRole
- else:
- ret = QtGui.QMessageBox.NoRole
-
- return ret, saved
-
- def closeEvent(self, event):
- """
- Close the window. but check if the user wants to save
- """
- self.buttonProcess.setFocus()
- if self.mod_flag:
- event.ignore()
- ret, saved = self._save_check()
- if ret == QtGui.QMessageBox.AcceptRole:
- if saved:
- self.mod_flag = False
- event.accept()
- elif ret == QtGui.QMessageBox.RejectRole:
- event.ignore()
- elif ret == QtGui.QMessageBox.NoRole:
- self.mod_flag = False
- event.accept()
-
- def _instrument_selected(self, instrument):
- """
- Change the default instrument to the selected one
- """
- config['default.instrument'] = self.instrument_list[instrument]
- logger.notice("Instrument is now: " + str(config['default.instrument']))
- self.textRB.clear()
- self._populate_runs_list()
- self.current_instrument = self.instrument_list[instrument]
- self.comboPolarCorrect.setEnabled(
- self.current_instrument in self.polarisation_instruments) # Enable as appropriate
- self.comboPolarCorrect.setCurrentIndex(self.comboPolarCorrect.findText('None')) # Reset to None
-
- def _table_modified(self, row, column):
- """
- sets the modified flag when the table is altered
- """
-
- # Sometimes users enter leading or trailing whitespace into a cell.
- # Let's remove it for them automatically.
- item = self.tableMain.item(row, column)
- item.setData(0, str.strip(str(item.data(0))))
-
- if not self.loading:
- self.mod_flag = True
- plotbutton = self.tableMain.cellWidget(row, self.plot_col).children()[1]
- self.__reset_plot_button(plotbutton)
-
- def _plot_row(self):
- """
- handler for the plot buttons
- """
- plotbutton = self.sender()
- self._plot(plotbutton)
-
- def _show_slit_calculator(self):
- calc = mantidqtpython.MantidQt.MantidWidgets.SlitCalculator(self)
- calc.setCurrentInstrumentName(self.current_instrument)
- calc.processInstrumentHasBeenChanged()
- calc.exec_()
-
- def _polar_corr_selected(self):
- """
- Event handler for polarisation correction selection.
- """
- if self.current_instrument in self.polarisation_instruments:
- chosen_method = self.comboPolarCorrect.currentText()
- self.current_polarisation_method = self.polarisation_options[chosen_method]
- else:
- logger.notice("Polarisation correction is not supported on " + str(self.current_instrument))
-
- def setup_layout(self):
- """
- Do further setup layout that couldn't be done in the designer
- """
- self.comboInstrument.addItems(self.instrument_list)
- current_instrument = config['default.instrument'].upper()
- if current_instrument in self.instrument_list:
- self.comboInstrument.setCurrentIndex(self.instrument_list.index(current_instrument))
- else:
- self.comboInstrument.setCurrentIndex(0)
- config['default.instrument'] = 'INTER'
- self.current_instrument = config['default.instrument'].upper()
-
- # Setup polarisation options with default assigned
- self.comboPolarCorrect.clear()
- self.comboPolarCorrect.addItems(list(self.polarisation_options.keys()))
- self.comboPolarCorrect.setCurrentIndex(self.comboPolarCorrect.findText('None'))
- self.current_polarisation_method = self.polarisation_options['None']
- self.comboPolarCorrect.setEnabled(self.current_instrument in self.polarisation_instruments)
- self.splitterList.setSizes([200, 800])
- self.labelStatus = QtGui.QLabel("Ready")
- self.statusMain.addWidget(self.labelStatus)
- self._initialise_table()
- self._populate_runs_list()
- self._connect_slots()
- return True
-
- def _reset_table(self):
- """
- Reset the plot buttons and stitch checkboxes back to their default state
- """
- # switches from current to true, to false to make sure stateChanged fires
- self.checkTickAll.setCheckState(2)
- self.checkTickAll.setCheckState(0)
- for row in range(self.tableMain.rowCount()):
- plotbutton = self.tableMain.cellWidget(row, self.plot_col).children()[1]
- self.__reset_plot_button(plotbutton)
-
- def __reset_plot_button(self, plotbutton):
- """
- Reset the provided plot button to ti's default state: disabled and with no cache
- """
- plotbutton.setDisabled(True)
- plotbutton.setProperty('runno', None)
- plotbutton.setProperty('overlapLow', None)
- plotbutton.setProperty('overlapHigh', None)
- plotbutton.setProperty('wksp', None)
-
- def _initialise_table(self):
- """
- Initialise the table. Clearing all data and adding the checkboxes and plot buttons
- """
- # first check if the table has been changed before clearing it
- if self.mod_flag:
- ret, _saved = self._save_check()
- if ret == QtGui.QMessageBox.RejectRole:
- return
- self.current_table = None
-
- settings = QtCore.QSettings()
- settings.beginGroup(self.__column_settings)
-
- for column in range(self.tableMain.columnCount()):
- for row in range(self.tableMain.rowCount()):
- if column in self.run_cols:
- item = QtGui.QTableWidgetItem()
- item.setText('')
- item.setToolTip('Runs can be colon delimited to coadd them')
- self.tableMain.setItem(row, column, item)
- elif column in self.angle_cols:
- item = QtGui.QTableWidgetItem()
- item.setText('')
- item.setToolTip('Angles are in degrees')
- self.tableMain.setItem(row, column, item)
- elif column == self.stitch_col:
- check = QtGui.QCheckBox()
- check.setCheckState(False)
- check.setToolTip('If checked, the runs in this row will be stitched together')
- item = QtGui.QWidget()
- layout = QtGui.QHBoxLayout(item)
- layout.addWidget(check)
- layout.setAlignment(QtCore.Qt.AlignCenter)
- layout.setSpacing(0)
- layout.setContentsMargins(0, 0, 0, 0)
- item.setLayout(layout)
- item.setContentsMargins(0, 0, 0, 0)
- self.tableMain.setCellWidget(row, self.stitch_col, item)
- elif column == self.plot_col:
- button = QtGui.QPushButton('Plot')
- button.setProperty("row", row)
- self.__reset_plot_button(button)
- button.setToolTip('Plot the workspaces produced by processing this row.')
- button.clicked.connect(self._plot_row)
- item = QtGui.QWidget()
- layout = QtGui.QHBoxLayout(item)
- layout.addWidget(button)
- layout.setAlignment(QtCore.Qt.AlignCenter)
- layout.setSpacing(0)
- layout.setContentsMargins(0, 0, 0, 0)
- item.setLayout(layout)
- item.setContentsMargins(0, 0, 0, 0)
- self.tableMain.setCellWidget(row, self.plot_col, item)
- else:
- item = QtGui.QTableWidgetItem()
- item.setText('')
- self.tableMain.setItem(row, column, item)
- vis_state = settings.value(str(column), True, type=bool)
- self.shown_cols[column] = vis_state
- if vis_state:
- self.tableMain.showColumn(column)
- else:
- self.tableMain.hideColumn(column)
- settings.endGroup()
- del settings
- self.tableMain.resizeColumnsToContents()
- self.mod_flag = False
-
- def _connect_slots(self):
- """
- Connect the signals to the corresponding methods
- """
- self.checkTickAll.stateChanged.connect(self._set_all_stitch)
- self.comboInstrument.activated[int].connect(self._instrument_selected)
- self.comboPolarCorrect.activated.connect(self._polar_corr_selected)
- self.textRB.returnPressed.connect(self._populate_runs_list)
- self.buttonAuto.clicked.connect(self._autofill)
- self.buttonSearch.clicked.connect(self._populate_runs_list)
- self.buttonClear.clicked.connect(self._initialise_table)
- self.buttonProcess.clicked.connect(self._process)
- self.buttonTransfer.clicked.connect(self._transfer)
- self.buttonColumns.clicked.connect(self._choose_columns)
- self.actionOpen_Table.triggered.connect(self._load_table)
- self.actionReload_from_Disk.triggered.connect(self._reload_table)
- self.actionSave.triggered.connect(self._save)
- self.actionSave_As.triggered.connect(self._save_as)
- self.actionSave_Workspaces.triggered.connect(self._save_workspaces)
- self.actionClose_Refl_Gui.triggered.connect(self.close)
- self.actionMantid_Help.triggered.connect(self._show_help)
- self.actionAutofill.triggered.connect(self._autofill)
- self.actionSearch_RB.triggered.connect(self._populate_runs_list)
- self.actionClear_Table.triggered.connect(self._initialise_table)
- self.actionProcess.triggered.connect(self._process)
- self.actionTransfer.triggered.connect(self._transfer)
- self.tableMain.cellChanged.connect(self._table_modified)
- self.actionClear.triggered.connect(self._clear_cells)
- self.actionPaste.triggered.connect(self._paste_cells)
- self.actionCut.triggered.connect(self._cut_cells)
- self.actionCopy.triggered.connect(self._copy_cells)
- self.actionChoose_Columns.triggered.connect(self._choose_columns)
- self.actionRefl_Gui_Options.triggered.connect(self._options_dialog)
- self.actionSlit_Calculator.triggered.connect(self._show_slit_calculator)
-
- def __valid_rb(self):
- # Ensure that you cannot put zero in for an rb search
- rbSearchValidator = QtGui.QIntValidator(self)
- current_text = self.textRB.text()
- rbSearchValidator.setBottom(1)
- state = rbSearchValidator.validate(current_text, 0)[0]
- if state == QtGui.QValidator.Acceptable:
- return True
- else:
- self.textRB.clear()
- if current_text:
- logger.warning("RB search restricted to numbers > 0")
- return False
-
- def _populate_runs_list(self):
- """
- Populate the list at the right with names of runs and workspaces from the archives
- """
- # Clear existing
- self.listMain.clear()
-
- if self.__valid_rb():
-
- # Use ICAT for a journal search based on the RB number
-
- active_session_id = None
- if CatalogManager.numberActiveSessions() == 0:
- # Execute the CatalogLoginDialog
- login_alg = CatalogLoginDialog()
- session_object = login_alg.getProperty("KeepAlive").value
- active_session_id = session_object.getPropertyValue("Session")
-
- # Fetch out an existing session id
- active_session_id = CatalogManager.getActiveSessions()[-1].getSessionId()
- # This might be another catalog session, but at present there is no way to tell.
-
- search_alg = AlgorithmManager.create('CatalogGetDataFiles')
- search_alg.initialize()
- search_alg.setChild(True) # Keeps the results table out of the ADS
- search_alg.setProperty('InvestigationId', str(self.textRB.text()))
- search_alg.setProperty('Session', active_session_id)
- search_alg.setPropertyValue('OutputWorkspace', '_dummy')
- search_alg.execute()
- search_results = search_alg.getProperty('OutputWorkspace').value
-
- self.icat_file_map = {}
- self.statusMain.clearMessage()
- for row in search_results:
- file_name = row['Name']
- file_id = row['Id']
- description = row['Description']
- run_number = re.search(r'[1-9]\d+', file_name).group()
-
- if bool(re.search('(raw)$', file_name, re.IGNORECASE)): # Filter to only display and map raw files.
- title = (run_number + ': ' + description).strip()
- self.icat_file_map[title] = (file_id, run_number, file_name)
- self.listMain.addItem(title)
- self.listMain.sortItems()
- del search_results
-
- def _autofill(self):
- """
- copy the contents of the selected cells to the row below as long as the row below contains a run number in the first cell
- """
- # make sure all selected cells are in the same row
- sum = 0
- howMany = len(self.tableMain.selectedItems())
- for cell in self.tableMain.selectedItems():
- sum = sum + self.tableMain.row(cell)
- if howMany:
- selectedrow = self.tableMain.row(self.tableMain.selectedItems()[0])
- if sum / howMany == selectedrow:
- startrow = selectedrow + 1
- filled = 0
- for cell in self.tableMain.selectedItems():
- row = startrow
- txt = cell.text()
- while self.tableMain.item(row, 0).text() != '':
- item = QtGui.QTableWidgetItem()
- item.setText(txt)
- self.tableMain.setItem(row, self.tableMain.column(cell), item)
- row = row + 1
- filled = filled + 1
- if not filled:
- QtGui.QMessageBox.critical(self.tableMain,
- 'Cannot perform Autofill',
- "No target cells to autofill. Rows to be filled should contain a run number in their "
- "first cell, and start from directly below the selected line.")
- else:
- QtGui.QMessageBox.critical(self.tableMain, 'Cannot perform Autofill',
- "Selected cells must all be in the same row.")
- else:
- QtGui.QMessageBox.critical(self.tableMain, 'Cannot perform Autofill', "There are no source cells selected.")
-
- def _clear_cells(self):
- """
- Clear the selected area of data
- """
- cells = self.tableMain.selectedItems()
- for cell in cells:
- column = cell.column()
- if column < self.stitch_col:
- cell.setText('')
-
- def _cut_cells(self):
- """
- copy the selected cells then clear the area
- """
- self._copy_cells()
- self._clear_cells()
-
- def _copy_cells(self):
- """
- Copy the selected ranage of cells to the clipboard
- """
- cells = self.tableMain.selectedItems()
- if not cells:
- print
- 'nothing to copy'
- return
- # first discover the size of the selection and initialise a list
- mincol = cells[0].column()
- if mincol > self.scale_col:
- logger.error("Cannot copy, all cells out of range")
- return
- maxrow = -1
- maxcol = -1
- minrow = cells[0].row()
- for cell in reversed(range(len(cells))):
- col = cells[cell].column()
- if col < self.stitch_col:
- maxcol = col
- maxrow = cells[cell].row()
- break
- colsize = maxcol - mincol + 1
- rowsize = maxrow - minrow + 1
- selection = [['' for x in range(colsize)] for y in range(rowsize)]
- # now fill that list
- for cell in cells:
- row = cell.row()
- col = cell.column()
- if col < self.stitch_col:
- selection[row - minrow][col - mincol] = str(cell.text())
- tocopy = ''
- for y in range(rowsize):
- for x in range(colsize):
- if x > 0:
- tocopy += '\t'
- tocopy += selection[y][x]
- if y < (rowsize - 1):
- tocopy += '\n'
- self.clip.setText(str(tocopy))
-
- def _paste_cells(self):
- """
- Paste the contents of the clipboard to the table at the selected position
- """
- pastedtext = self.clip.text()
- if not pastedtext:
- logger.warning("Nothing to Paste")
- return
- selected = self.tableMain.selectedItems()
- if not selected:
- logger.warning("Cannot paste, no editable cells selected")
- return
- pasted = pastedtext.splitlines()
- pastedcells = []
- for row in pasted:
- pastedcells.append(row.split('\t'))
- pastedcols = len(pastedcells[0])
- pastedrows = len(pastedcells)
- if len(selected) > 1:
- # discover the size of the selection
- mincol = selected[0].column()
- if mincol > self.scale_col:
- logger.error("Cannot copy, all cells out of range")
- return
- minrow = selected[0].row()
- # now fill that list
- for cell in selected:
- row = cell.row()
- col = cell.column()
- if col < self.stitch_col and (col - mincol) < pastedcols and (row - minrow) < pastedrows and len(
- pastedcells[row - minrow]):
- cell.setText(pastedcells[row - minrow][col - mincol])
- elif selected:
- # when only a single cell is selected, paste all the copied item up until the table limits
- cell = selected[0]
- currow = cell.row()
- homecol = cell.column()
- tablerows = self.tableMain.rowCount()
- for row in pastedcells:
- if len(row):
- curcol = homecol
- if currow < tablerows:
- for col in row:
- if curcol < self.stitch_col:
- curcell = self.tableMain.item(currow, curcol)
- curcell.setText(col)
- curcol += 1
- else:
- # the row has hit the end of the editable cells
- break
- currow += 1
- else:
- # it's dropped off the bottom of the table
- break
- else:
- logger.warning("Cannot paste, no editable cells selected")
-
- def _transfer(self):
- """
- Transfer run numbers to the table
- """
-
- tup = ()
- for idx in self.listMain.selectedItems():
- split_title = re.split(":th=|th=|:|dq/q=", idx.text())
- if len(split_title) < 3:
- split_title = re.split(":", idx.text())
- if len(split_title) < 2:
- logger.warning('cannot transfer ' + idx.text() + ' title is not in the right form ')
- continue
- else:
- theta = 0
- split_title.append(theta) # Append a dummy theta value.
- if len(split_title) < 4:
- dqq = 0
- split_title.append(dqq) # Append a dummy dq/q value.
- tup = tup + (split_title,) # Tuple of lists containing (run number, title, theta, dq/q)
-
- tupsort = sorted(tup, key=itemgetter(1, 2)) # now sorted by title then theta
- row = 0
- for _key, group in itertools.groupby(tupsort, lambda x: x[1]): # now group by title
- col = 0
- dqq = 0 # only one value of dqq per row
- run_angle_pairs_of_title = list() # for storing run_angle pairs all with the same title
- for object in group: # loop over all with equal title
-
- run_no = object[0]
- dqq = object[-1]
- angle = object[-2]
- run_angle_pairs_of_title.append((run_no, angle))
-
- for angle_key, group in itertools.groupby(run_angle_pairs_of_title, lambda x: x[1]):
- runnumbers = "+".join(["%s" % pair[0] for pair in group])
-
- # set the runnumber
- item = QtGui.QTableWidgetItem()
- item.setText(str(runnumbers))
- self.tableMain.setItem(row, col, item)
-
- # Set the angle
- item = QtGui.QTableWidgetItem()
- item.setText(str(angle_key))
- self.tableMain.setItem(row, col + 1, item)
-
- # Set the transmission
- item = QtGui.QTableWidgetItem()
- item.setText(self.textRuns.text())
- self.tableMain.setItem(row, col + 2, item)
-
- col = col + 5
- if col >= 11:
- col = 0
-
- # set dq/q
- item = QtGui.QTableWidgetItem()
- item.setText(str(dqq))
- self.tableMain.setItem(row, 15, item)
-
- row = row + 1
-
- if self.__icat_download:
-
- # If ICAT is being used for download, then files must be downloaded at the same time as they are transferred
-
- contents = str(idx.text()).strip()
- file_id, _runnumber, file_name = self.icat_file_map[contents]
- active_session_id = CatalogManager.getActiveSessions()[-1].getSessionId()
- # This might be another catalog session, but at present there is no way to tell.
-
- save_location = config['defaultsave.directory']
-
- CatalogDownloadDataFiles(file_id, FileNames=file_name, DownloadPath=save_location,
- Session=active_session_id)
-
- current_search_dirs = config.getDataSearchDirs()
-
- if save_location not in current_search_dirs:
- config.appendDataSearchDir(save_location)
-
- def _set_all_stitch(self, state):
- """
- Set the checkboxes in the Stitch? column to the same
- """
- for row in range(self.tableMain.rowCount()):
- self.tableMain.cellWidget(row, self.stitch_col).children()[1].setCheckState(state)
-
- def __checked_row_stiched(self, row):
- return self.tableMain.cellWidget(row, self.stitch_col).children()[1].checkState() > 0
-
- def _process(self):
- """
- Process has been pressed, check what has been selected then pass the selection (or whole table) to quick
- """
- # --------- If "Process" button pressed, convert raw files to IvsLam and IvsQ and combine if checkbox ticked -------------
- _overallQMin = float("inf")
- _overallQMax = float("-inf")
- try:
- willProcess = True
- rows = self.tableMain.selectionModel().selectedRows()
- rowIndexes = []
- for idx in rows:
- rowIndexes.append(idx.row())
- rowIndexes, willProcess = self._row_check(rowIndexes, willProcess)
- if willProcess:
- for row in rowIndexes: # range(self.tableMain.rowCount()):
- runno = []
- wksp = []
- overlapLow = []
- overlapHigh = []
- if self.tableMain.item(row, 0).text() != '':
- self.statusMain.showMessage("Processing row: " + str(row + 1))
- logger.debug("Processing row: " + str(row + 1))
-
- for i in range(3):
- run_entry = str(self.tableMain.item(row, i * 5).text())
- if run_entry != '':
- runno.append(run_entry)
- ovLow = str(self.tableMain.item(row, (i * 5) + 3).text())
- if ovLow != '':
- overlapLow.append(float(ovLow))
- ovHigh = str(self.tableMain.item(row, (i * 5) + 4).text())
- if ovHigh != '':
- overlapHigh.append(float(ovHigh))
- # Determine resolution
- if self.tableMain.item(row, 15).text() == '':
- loadedRun = None
- if load_live_runs.is_live_run(runno[0]):
- loadedRun = load_live_runs.get_live_data(config['default.instrument'],
- frequency=self.live_freq,
- accumulation=self.live_method)
- else:
- Load(Filename=runno[0], OutputWorkspace="_run")
- loadedRun = mtd["_run"]
- theta_in_str = str(self.tableMain.item(row, 1).text())
- try:
- theta_in = None
- if len(theta_in_str) > 0:
- theta_in = float(theta_in_str)
-
- # Make sure we only ever run calculate resolution on a non-group workspace.
- # If we're given a group workspace, we can just run it on the first member of the group instead
- thetaRun = loadedRun
- if isinstance(thetaRun, WorkspaceGroup):
- thetaRun = thetaRun[0]
- if not theta_in:
- theta_in = getLogValue(thetaRun, "Theta")
- dqq = NRCalculateSlitResolution(Workspace=thetaRun, TwoTheta=2 * theta_in)
-
- # Put the calculated resolution into the table
- resItem = QtGui.QTableWidgetItem()
- resItem.setText(str(dqq))
- self.tableMain.setItem(row, 15, resItem)
-
- # Update the value for theta_in in the table
- ttItem = QtGui.QTableWidgetItem()
- ttItem.setText(str(theta_in))
- self.tableMain.setItem(row, 1, ttItem)
-
- logger.notice("Calculated resolution: " + str(dqq))
- except:
- self.statusMain.clearMessage()
- logger.error(
- "Failed to calculate dq/q because we could not find theta in the workspace's sample log. "
- "Try entering theta or dq/q manually.")
- return
- else:
- dqq = float(self.tableMain.item(row, 15).text())
-
- self._check_theta_columns(row)
-
- overlapHigh = self._populate_runlist(_overallQMax, _overallQMin, dqq, overlapHigh, overlapLow,
- row, runno, wksp)
-
- # Enable the plot button
- plotbutton = self.tableMain.cellWidget(row, self.plot_col).children()[1]
- plotbutton.setProperty('runno', runno)
- plotbutton.setProperty('overlapLow', overlapLow)
- plotbutton.setProperty('overlapHigh', overlapHigh)
- plotbutton.setProperty('wksp', wksp)
- plotbutton.setEnabled(True)
- self.statusMain.clearMessage()
- self.accMethod = None
- self.statusMain.clearMessage()
- except:
- self.statusMain.clearMessage()
- raise
-
- def _check_theta_columns(self, row):
- # Check secondary and tertiary theta_in columns, if they're
- # blank and their corresponding run columns are set, fill them.
- for run_col in [5, 10]:
- tht_col = run_col + 1
- run_val = str(self.tableMain.item(row, run_col).text())
- tht_val = str(self.tableMain.item(row, tht_col).text())
- if run_val and not tht_val:
- Load(Filename=run_val, OutputWorkspace="_run")
- loadedRun = mtd["_run"]
- tht_val = getLogValue(loadedRun, "Theta")
- if tht_val:
- self.tableMain.item(row, tht_col).setText(str(tht_val))
-
- def _row_check(self, rowIndexes, willProcess):
- if not len(rowIndexes):
- reply = QtGui.QMessageBox.question(self.tableMain, 'Process all rows?',
- "This will process all rows in the table. Continue?",
- QtGui.QMessageBox.Yes, QtGui.QMessageBox.No)
- if reply == QtGui.QMessageBox.No:
- logger.notice("Cancelled!")
- willProcess = False
- else:
- rowIndexes = range(self.tableMain.rowCount())
- return rowIndexes, willProcess
-
- def _populate_runlist(self, _overallQMax, _overallQMin, dqq, overlapHigh, overlapLow, row, runno, wksp):
- # Populate runlist
- first_wq = None
- for i in range(0, len(runno)):
- theta, qmin, qmax, _wlam, wqBinnedAndScaled, _wqUnBinnedAndUnScaled = \
- self._do_run(runno[i], row, i)
- if not first_wq:
- first_wq = wqBinnedAndScaled # Cache the first Q workspace
- theta = round(theta, 3)
- qmin = round(qmin, 3)
- qmax = round(qmax, 3)
- wksp.append(wqBinnedAndScaled.name())
- if self.tableMain.item(row, i * 5 + 1).text() == '':
- item = QtGui.QTableWidgetItem()
- item.setText(str(theta))
- self.tableMain.setItem(row, i * 5 + 1, item)
- if self.tableMain.item(row, i * 5 + 3).text() == '':
- item = QtGui.QTableWidgetItem()
- item.setText(str(qmin))
- self.tableMain.setItem(row, i * 5 + 3, item)
- overlapLow.append(qmin)
- if self.tableMain.item(row, i * 5 + 4).text() == '':
- item = QtGui.QTableWidgetItem()
- item.setText(str(qmax))
- self.tableMain.setItem(row, i * 5 + 4, item)
- overlapHigh.append(qmax)
- if wksp[i].find(',') > 0 or wksp[i].find(':') > 0:
- wksp[i] = first_wq.name()
- overlapHigh = self._check_stiched_row(_overallQMax, _overallQMin, dqq, i, overlapHigh,
- overlapLow, row, runno, wksp)
- return overlapHigh
-
- def _check_stiched_row(self, _overallQMax, _overallQMin, dqq, i, overlapHigh, overlapLow, row, runno, wksp):
- if self.__checked_row_stiched(row):
- if len(runno) == 1:
- logger.notice("Nothing to combine for processing row : " + str(row))
- else:
- w1 = getWorkspace(wksp[0])
- w2 = getWorkspace(wksp[-1])
- if len(runno) == 2:
- outputwksp = runno[0] + '_' + runno[1][3:]
- else:
- outputwksp = runno[0] + '_' + runno[-1][3:]
- # get Qmax
- if self.tableMain.item(row, i * 5 + 4).text() == '':
- overlapHigh = 0.3 * max(w1.readX(0))
-
- Qmin = min(w1.readX(0))
- Qmax = max(w2.readX(0))
- if len(self.tableMain.item(row, i * 5 + 3).text()) > 0:
- Qmin = float(self.tableMain.item(row, i * 5 + 3).text())
- if len(self.tableMain.item(row, i * 5 + 4).text()) > 0:
- Qmax = float(self.tableMain.item(row, i * 5 + 4).text())
- if Qmax > _overallQMax:
- _overallQMax = Qmax
- if Qmin < _overallQMin:
- _overallQMin = Qmin
-
- combineDataMulti(wksp, outputwksp, overlapLow, overlapHigh,
- _overallQMin, _overallQMax, -dqq, 1, keep=True,
- scale_right=self.__scale_right)
- return overlapHigh
-
- def _plot(self, plotbutton):
- """
- Plot the row belonging to the selected button
- """
- if not isinstance(plotbutton, QtGui.QPushButton):
- logger.error("Problem accessing cached data: Wrong data type passed, expected QtGui.QPushbutton")
- return
- import unicodedata
-
- # make sure the required data can be retrieved properly
- try:
- runno_u = plotbutton.property('runno')
- runno = []
- for uni in runno_u:
- runno.append(unicodedata.normalize('NFKD', uni).encode('ascii', 'ignore'))
- wksp_u = plotbutton.property('wksp')
- wksp = []
- for uni in wksp_u:
- wksp.append(unicodedata.normalize('NFKD', uni).encode('ascii', 'ignore'))
- overlapLow = plotbutton.property('overlapLow')
- overlapHigh = plotbutton.property('overlapHigh')
- row = plotbutton.property('row')
- wkspBinned = []
- w1 = getWorkspace(wksp[0])
- w2 = getWorkspace(wksp[len(wksp) - 1])
- dqq = float(self.tableMain.item(row, 15).text())
- except:
- logger.error("Unable to plot row, required data couldn't be retrieved")
- self.__reset_plot_button(plotbutton)
- return
- for i in range(len(runno)):
- if len(overlapLow):
- Qmin = overlapLow[0]
- else:
- Qmin = min(w1.readX(0))
- if len(overlapHigh):
- Qmax = overlapHigh[len(overlapHigh) - 1]
- else:
- Qmax = max(w2.readX(0))
- ws_name_binned = wksp[i]
- wkspBinned.append(ws_name_binned)
- wsb = getWorkspace(ws_name_binned)
- _Imin = min(wsb.readY(0))
- _Imax = max(wsb.readY(0))
-
- if canMantidPlot:
- # Get the existing graph if it exists
- base_graph = self.__graphs.get(wksp[0], None)
-
- # Clear the window if we're the first of a new set of curves
- clearWindow = (i == 0)
-
- # Plot the new curve
- base_graph = plotSpectrum(ws_name_binned, 0, True, window=base_graph, clearWindow=clearWindow)
-
- # Save the graph so we can re-use it
- self.__graphs[wksp[i]] = base_graph
-
- titl = groupGet(ws_name_binned, 'samp', 'run_title')
- if isinstance(titl, str):
- base_graph.activeLayer().setTitle(titl)
- base_graph.activeLayer().setAxisScale(Layer.Left, _Imin * 0.1, _Imax * 10, Layer.Log10)
- base_graph.activeLayer().setAxisScale(Layer.Bottom, Qmin * 0.9, Qmax * 1.1, Layer.Log10)
- base_graph.activeLayer().setAutoScale()
-
- # Create and plot stitched outputs
- if self.__checked_row_stiched(row):
- if len(runno) == 2:
- outputwksp = runno[0] + '_' + runno[1][3:]
- else:
- outputwksp = runno[0] + '_' + runno[2][3:]
- if not getWorkspace(outputwksp, report_error=False):
- # Stitching has not been done as part of processing, so we need to do it here.
- combineDataMulti(wkspBinned, outputwksp, overlapLow, overlapHigh, Qmin, Qmax, -dqq, 1,
- keep=True, scale_right=self.__scale_right)
-
- Qmin = min(getWorkspace(outputwksp).readX(0))
- Qmax = max(getWorkspace(outputwksp).readX(0))
- if canMantidPlot:
- stitched_graph = self.__graphs.get(outputwksp, None)
- stitched_graph = plotSpectrum(outputwksp, 0, True, window=stitched_graph, clearWindow=True)
- titl = groupGet(outputwksp, 'samp', 'run_title')
- stitched_graph.activeLayer().setTitle(titl)
- stitched_graph.activeLayer().setAxisScale(Layer.Left, 1e-8, 100.0, Layer.Log10)
- stitched_graph.activeLayer().setAxisScale(Layer.Bottom, Qmin * 0.9, Qmax * 1.1, Layer.Log10)
- self.__graphs[outputwksp] = stitched_graph
-
- def __name_trans(self, transrun):
- """
- From a comma or colon separated string of run numbers
- construct an output workspace name for the transmission workspace that fits the form
- TRANS_{trans_1}_{trans_2}
- """
-
- if bool(re.search("^(TRANS)", transrun)):
- # The user has deliberately tried to supply the transmission run directly
- return transrun
- else:
- split_trans = re.split(',|:', transrun)
- if len(split_trans) == 0:
- return None
- name = 'TRANS'
- for t in split_trans:
- name += '_' + str(t)
- return name
-
- def _do_run(self, runno, row, which):
- """
- Run quick on the given run and row
- """
- transrun = str(self.tableMain.item(row, (which * 5) + 2).text())
- # Formulate a WS Name for the processed transmission run.
- transrun_named = self.__name_trans(transrun)
- # Look for existing transmission workspaces that match the name
- transmission_ws = self.check_existing_transmission(transrun_named)
-
- angle_str = str(self.tableMain.item(row, which * 5 + 1).text())
-
- if len(angle_str) > 0:
- angle = float(angle_str)
- else:
- angle = None
-
- loadedRun = runno
- if load_live_runs.is_live_run(runno):
- load_live_runs.get_live_data(config['default.instrument'], frequency=self.live_freq,
- accumulation=self.live_method)
- wlam, wq, th, wqBinned = None, None, None, None
-
- transmission_ws = self._make_transmission_workspace(transmission_ws, transrun, transrun_named)
-
- # Load the runs required ConvertToWavelength will deal with the transmission runs, while .to_workspace will deal with the run itself
- ws = ConvertToWavelength.to_workspace(loadedRun, ws_prefix="")
-
- if self.__alg_use:
- if self.tableMain.item(row, self.scale_col).text():
- factor = float(self.tableMain.item(row, self.scale_col).text())
- else:
- factor = 1.0
- if self.tableMain.item(row, 15).text():
- Qstep = float(self.tableMain.item(row, 15).text())
- else:
- Qstep = None
- if len(self.tableMain.item(row, which * 5 + 3).text()) > 0:
- Qmin = float(self.tableMain.item(row, which * 5 + 3).text())
- else:
- Qmin = None
- if len(self.tableMain.item(row, which * 5 + 4).text()) > 0:
- Qmax = float(self.tableMain.item(row, which * 5 + 4).text())
- else:
- Qmax = None
- # If we're dealing with a workspace group, we'll manually map execution over each group member
- # We do this so we can get ThetaOut correctly (see ticket #10597 for why we can't at the moment)
- if isinstance(ws, WorkspaceGroup):
- th, wlam, wq, wqBinned = self._process_workspace_group(Qmax, Qmin, Qstep, angle, factor, runno, th, transmission_ws, wlam,
- wq, wqBinned, ws)
- else:
- th, wlam, wq, wqBinned = self._process_workspace(Qmax, Qmin, Qstep, angle, factor, runno, th, transmission_ws, wlam, wq,
- wqBinned, ws)
-
- cleanup()
- else:
- wlam, wq, th = quick(loadedRun, trans=transmission_ws, theta=angle, tof_prefix="")
-
- if self.__group_tof_workspaces and not isinstance(ws, WorkspaceGroup):
- if "TOF" in mtd:
- tof_group = mtd["TOF"]
- if not tof_group.contains(loadedRun):
- tof_group.add(loadedRun)
- else:
- tof_group = GroupWorkspaces(InputWorkspaces=loadedRun, OutputWorkspace="TOF")
-
- if ':' in runno:
- runno = runno.split(':')[0]
- if ',' in runno:
- runno = runno.split(',')[0]
- if isinstance(wq, WorkspaceGroup):
- inst = wq[0].getInstrument()
- else:
- inst = wq.getInstrument()
-
- lmin = inst.getNumberParameter('LambdaMin')[0]
- lmax = inst.getNumberParameter('LambdaMax')[0]
- qmin = 4 * math.pi / lmax * math.sin(th * math.pi / 180)
- qmax = 4 * math.pi / lmin * math.sin(th * math.pi / 180)
-
- return th, qmin, qmax, wlam, wqBinned, wq
-
- def _make_transmission_workspace(self, transmission_ws, transrun, transrun_named):
- # Only make a transmission workspace if we need one.
- if transrun and not transmission_ws:
- converter = ConvertToWavelength(transrun)
- size = converter.get_ws_list_size()
- out_ws_name = transrun_named
- if size == 1:
- trans1 = converter.get_workspace_from_list(0)
-
- transmission_ws = CreateTransmissionWorkspaceAuto(FirstTransmissionRun=trans1,
- OutputWorkspace=out_ws_name,
- Params=0.02, StartOverlap=10.0, EndOverlap=12.0,
- Version=1)
- elif size == 2:
- trans1 = converter.get_workspace_from_list(0)
- trans2 = converter.get_workspace_from_list(1)
- transmission_ws = CreateTransmissionWorkspaceAuto(FirstTransmissionRun=trans1,
- OutputWorkspace=out_ws_name,
- SecondTransmissionRun=trans2, Params=0.02,
- StartOverlap=10.0, EndOverlap=12.0, Version=1)
- else:
- raise RuntimeError("Up to 2 transmission runs can be specified. No more than that.")
- return transmission_ws
-
- def _process_workspace(self, Qmax, Qmin, Qstep, angle, factor, runno, th, transmission_ws, wlam, wq, wqBinned, ws):
- alg = AlgorithmManager.create("ReflectometryReductionOneAuto")
- alg.initialize()
- alg.setProperty("Debug", True)
- alg.setProperty("InputWorkspace", ws)
- if transmission_ws:
- alg.setProperty("FirstTransmissionRun", transmission_ws)
- if angle is not None:
- alg.setProperty("ThetaIn", angle)
- alg.setProperty("OutputWorkspaceBinned", runno + '_IvsQ_binned')
- alg.setProperty("OutputWorkspace", runno + '_IvsQ')
- alg.setProperty("OutputWorkspaceWavelength", runno + '_IvsLam')
- alg.setProperty("ScaleFactor", factor)
- if Qstep is not None:
- alg.setProperty("MomentumTransferStep", Qstep)
- if Qmin is not None:
- alg.setProperty("MomentumTransferMin", Qmin)
- if Qmax is not None:
- alg.setProperty("MomentumTransferMax", Qmax)
- alg.execute()
- wqBinned = mtd[runno + '_IvsQ_binned']
- wq = mtd[runno + '_IvsQ']
- wlam = mtd[runno + '_IvsLam']
- th = alg.getProperty("ThetaIn").value
- return th, wlam, wq, wqBinned
-
- def _process_workspace_group(self, Qmax, Qmin, Qstep, angle, factor, runno, th, transmission_ws, wlam, wq, wqBinned, ws):
- wqGroupBinned = []
- wqGroup = []
- wlamGroup = []
- thetaGroup = []
- group_trans_ws = transmission_ws
- for i in range(0, ws.size()):
- # If the transmission workspace is a group, we'll use it pair-wise with the tof workspace group
- if isinstance(transmission_ws, WorkspaceGroup):
- group_trans_ws = transmission_ws[i]
-
- alg = AlgorithmManager.create("ReflectometryReductionOneAuto")
- alg.initialize()
- alg.setProperty("Debug", True)
- alg.setProperty("InputWorkspace", ws[i])
- if group_trans_ws:
- alg.setProperty("FirstTransmissionRun", group_trans_ws)
- if angle is not None:
- alg.setProperty("ThetaIn", angle)
- alg.setProperty("OutputWorkspaceBinned", runno + '_IvsQ_binned_' + str(i + 1))
- alg.setProperty("OutputWorkspace", runno + '_IvsQ_' + str(i + 1))
- alg.setProperty("OutputWorkspaceWavelength", runno + '_IvsLam_' + str(i + 1))
- alg.setProperty("ScaleFactor", factor)
- if Qstep is not None:
- alg.setProperty("MomentumTransferStep", Qstep)
- if Qmin is not None:
- alg.setProperty("MomentumTransferMin", Qmin)
- if Qmax is not None:
- alg.setProperty("MomentumTransferMax", Qmax)
- alg.execute()
- wqBinned = mtd[runno + '_IvsQ_binned_' + str(i + 1)]
- wq = mtd[runno + '_IvsQ_' + str(i + 1)]
- wlam = mtd[runno + '_IvsLam_' + str(i + 1)]
- th = alg.getProperty("ThetaIn").value
-
- wqGroupBinned.append(wqBinned)
- wqGroup.append(wq)
- wlamGroup.append(wlam)
- thetaGroup.append(th)
- wqBinned = GroupWorkspaces(InputWorkspaces=wqGroupBinned, OutputWorkspace=runno + '_IvsQ_binned')
- wq = GroupWorkspaces(InputWorkspaces=wqGroup, OutputWorkspace=runno + '_IvsQ')
- wlam = GroupWorkspaces(InputWorkspaces=wlamGroup, OutputWorkspace=runno + '_IvsLam')
- th = thetaGroup[0]
- return th, wlam, wq, wqBinned
-
- def check_existing_transmission(self, transrun_named):
- transmission_ws = None
- if mtd.doesExist(transrun_named):
- if isinstance(mtd[transrun_named], WorkspaceGroup):
- unit = mtd[transrun_named][0].getAxis(0).getUnit().unitID()
- else:
- unit = mtd[transrun_named].getAxis(0).getUnit().unitID()
-
- if unit == "Wavelength":
- logger.notice('Reusing transmission workspace ' + transrun_named)
- transmission_ws = mtd[transrun_named]
- return transmission_ws
-
- def _save_table_contents(self, filename):
- """
- Save the contents of the table
- """
- try:
- writer = csv.writer(open(filename, "wb"))
- for row in range(self.tableMain.rowCount()):
- rowtext = []
- for column in range(self.tableMain.columnCount() - 2):
- rowtext.append(self.tableMain.item(row, column).text())
- if len(rowtext) > 0:
- writer.writerow(rowtext)
- self.current_table = filename
- logger.notice("Saved file to " + filename)
- self.mod_flag = False
- except:
- return False
- self.mod_flag = False
- return True
-
- def _save(self, failsave=False):
- """
- Save the table, showing no interface if not necessary. This also provides the failing save functionality.
- """
- filename = ''
- if failsave:
- # this is an emergency autosave as the program is failing
- logger.error(
- "The ISIS Reflectonomy GUI has encountered an error, it will now attempt to save a copy of your work.")
- msgBox = QtGui.QMessageBox()
- msgBox.setText(
- "The ISIS Reflectonomy GUI has encountered an error, it will now attempt to save a copy of your work.\n"
- "Please check the log for details.")
- msgBox.setStandardButtons(QtGui.QMessageBox.Ok)
- msgBox.setIcon(QtGui.QMessageBox.Critical)
- msgBox.setDefaultButton(QtGui.QMessageBox.Ok)
- msgBox.setEscapeButton(QtGui.QMessageBox.Ok)
- msgBox.exec_()
- import datetime
- failtime = datetime.datetime.today().strftime('%Y-%m-%d_%H-%M-%S')
- if self.current_table:
- filename = self.current_table.rsplit('.', 1)[0] + "_recovered_" + failtime + ".tbl"
- else:
- mantidDefault = config['defaultsave.directory']
- if os.path.exists(mantidDefault):
- filename = os.path.join(mantidDefault, "mantid_reflectometry_recovered_" + failtime + ".tbl")
- else:
- import tempfile
- tempDir = tempfile.gettempdir()
- filename = os.path.join(tempDir, "mantid_reflectometry_recovered_" + failtime + ".tbl")
- else:
- # this is a save-on-quit or file->save
- if self.current_table:
- filename = self.current_table
- else:
- saveDialog = QtGui.QFileDialog(self.widgetMainRow.parent(), "Save Table")
- saveDialog.setFileMode(QtGui.QFileDialog.AnyFile)
- saveDialog.setNameFilter("Table Files (*.tbl);;All files (*)")
- saveDialog.setDefaultSuffix("tbl")
- saveDialog.setAcceptMode(QtGui.QFileDialog.AcceptSave)
- if saveDialog.exec_():
- filename = saveDialog.selectedFiles()[0]
- else:
- return False
- return self._save_table_contents(filename)
-
- def _save_as(self):
- """
- show the save as dialog and save to a .tbl file with that name
- """
- saveDialog = QtGui.QFileDialog(self.widgetMainRow.parent(), "Save Table")
- saveDialog.setFileMode(QtGui.QFileDialog.AnyFile)
- saveDialog.setNameFilter("Table Files (*.tbl);;All files (*)")
- saveDialog.setDefaultSuffix("tbl")
- saveDialog.setAcceptMode(QtGui.QFileDialog.AcceptSave)
- if saveDialog.exec_():
- filename = saveDialog.selectedFiles()[0]
- self._save_table_contents(filename)
-
- def _load_table(self):
- """
- Load a .tbl file from disk
- """
- self.loading = True
- loadDialog = QtGui.QFileDialog(self.widgetMainRow.parent(), "Open Table")
- loadDialog.setFileMode(QtGui.QFileDialog.ExistingFile)
- loadDialog.setNameFilter("Table Files (*.tbl);;All files (*)")
- if loadDialog.exec_():
- try:
- # before loading make sure you give them a chance to save
- if self.mod_flag:
- ret, _saved = self._save_check()
- if ret == QtGui.QMessageBox.RejectRole:
- # if they hit cancel abort the load
- self.loading = False
- return
- self._reset_table()
- filename = loadDialog.selectedFiles()[0]
- self.current_table = filename
- reader = csv.reader(open(filename, "rb"))
- row = 0
- for line in reader:
- if row < 100:
- for column in range(self.tableMain.columnCount() - 2):
- item = QtGui.QTableWidgetItem()
- item.setText(line[column])
- self.tableMain.setItem(row, column, item)
- row = row + 1
- except:
- logger.error('Could not load file: ' + str(filename) + '. File not found or unable to read from file.')
- self.loading = False
- self.mod_flag = False
-
- def _reload_table(self):
- """
- Reload the last loaded file from disk, replacing anything in the table already
- """
- self.loading = True
- filename = self.current_table
- if filename:
- if self.mod_flag:
- msgBox = QtGui.QMessageBox()
- msgBox.setText(
- "The table has been modified. Are you sure you want to reload the table and lose your changes?")
- msgBox.setStandardButtons(QtGui.QMessageBox.Yes | QtGui.QMessageBox.No)
- msgBox.setIcon(QtGui.QMessageBox.Question)
- msgBox.setDefaultButton(QtGui.QMessageBox.Yes)
- msgBox.setEscapeButton(QtGui.QMessageBox.No)
- ret = msgBox.exec_()
- if ret == QtGui.QMessageBox.No:
- # if they hit No abort the reload
- self.loading = False
- return
- try:
- self._reset_table()
- reader = csv.reader(open(filename, "rb"))
- row = 0
- for line in reader:
- if row < 100:
- for column in range(self.tableMain.columnCount() - 2):
- item = QtGui.QTableWidgetItem()
- item.setText(line[column])
- self.tableMain.setItem(row, column, item)
- row = row + 1
- self.mod_flag = False
- except:
- logger.error('Could not load file: ' + str(filename) + '. File not found or unable to read from file.')
- else:
- logger.notice('No file in table to reload.')
- self.loading = False
-
- def _save_workspaces(self):
- """
- Shows the export dialog for saving workspaces to non mantid formats
- """
- try:
- Dialog = QtGui.QDialog()
- u = Ui_SaveWindow()
- u.setupUi(Dialog)
- Dialog.exec_()
- except Exception as ex:
- logger.notice("Could not open save workspace dialog")
- logger.notice(str(ex))
-
- def _options_dialog(self):
- """
- Shows the dialog for setting options regarding live data
- """
- try:
-
- dialog_controller = ReflOptions(def_method=self.live_method, def_freq=self.live_freq,
- def_alg_use=self.__alg_use,
- def_icat_download=self.__icat_download,
- def_group_tof_workspaces=self.__group_tof_workspaces,
- def_stitch_right=self.__scale_right)
- if dialog_controller.exec_():
- # Fetch the settings back off the controller
- self.live_freq = dialog_controller.frequency()
- self.live_method = dialog_controller.method()
- self.__alg_use = dialog_controller.useAlg()
- self.__icat_download = dialog_controller.icatDownload()
- self.__group_tof_workspaces = dialog_controller.groupTOFWorkspaces()
- self.__scale_right = dialog_controller.stitchRight()
-
- # Persist the settings
- settings = QtCore.QSettings()
- settings.beginGroup(self.__live_data_settings)
- settings.setValue(self.__live_data_frequency_key, self.live_freq)
- settings.setValue(self.__live_data_method_key, self.live_method)
- settings.endGroup()
- settings.beginGroup(self.__generic_settings)
- settings.setValue(self.__ads_use_key, self.__alg_use)
- settings.setValue(self.__icat_download_key, self.__icat_download)
- settings.setValue(self.__group_tof_workspaces_key, self.__group_tof_workspaces)
- settings.setValue(self.__stitch_right_key, self.__scale_right)
- settings.endGroup()
- del settings
- except Exception as ex:
- logger.notice("Problem opening options dialog or problem retrieving values from dialog")
- logger.notice(str(ex))
-
- def _choose_columns(self):
- """
- shows the choose columns dialog for hiding and revealing of columns
- """
- try:
- dialog = ReflChoose(self.shown_cols, self.tableMain)
- if dialog.exec_():
- settings = QtCore.QSettings()
- settings.beginGroup(self.__column_settings)
- for key, value in dialog.visiblestates.iteritems():
- self.shown_cols[key] = value
- settings.setValue(str(key), value)
- if value:
- self.tableMain.showColumn(key)
- else:
- self.tableMain.hideColumn(key)
- settings.endGroup()
- del settings
- except Exception as ex:
- logger.notice("Could not open choose columns dialog")
- logger.notice(str(ex))
-
- def _show_help(self):
- """
- Launches the wiki page for this interface
- """
- import webbrowser
- webbrowser.open('http://www.mantidproject.org/ISIS_Reflectometry_GUI')
-
-
-def getLogValue(wksp, field=''):
- """
- returns the last value from a sample log
- """
- ws = getWorkspace(wksp)
- log = ws.getRun().getLogData(field).value
-
- if isinstance(log, int) or isinstance(log, str):
- return log
- else:
- return log[-1]
-
-
-def getWorkspace(wksp, report_error=True):
- """
- Gets the first workspace associated with the given string. Does not load.
- """
- if isinstance(wksp, Workspace):
- return wksp
- elif isinstance(wksp, str):
- exists = mtd.doesExist(wksp)
- if not exists:
- if report_error:
- logger.error("Unable to get workspace: " + str(wksp))
- return exists # Doesn't exist
- else:
- return exists # Doesn't exist
- elif isinstance(mtd[wksp], WorkspaceGroup):
- wout = mtd[wksp][0]
- else:
- wout = mtd[wksp]
- return wout
diff --git a/scripts/Interface/ui/reflectometer/refl_gui_run.py b/scripts/Interface/ui/reflectometer/refl_gui_run.py
deleted file mode 100644
index 4b9d22bce1e977462a78e2f92dceb35071bc98e5..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/refl_gui_run.py
+++ /dev/null
@@ -1,19 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-#pylint: disable=invalid-name
-from __future__ import (absolute_import, division, print_function)
-from ui.reflectometer.refl_gui import ReflGui
-from PyQt4 import QtGui
-
-if __name__ == "__main__":
- import sys
- app = QtGui.QApplication(sys.argv)
- MainWindow = QtGui.QMainWindow()
- ui = ReflGui()
- ui.setupUi(MainWindow)
- MainWindow.show()
- sys.exit(app.exec_())
diff --git a/scripts/Interface/ui/reflectometer/refl_options.py b/scripts/Interface/ui/reflectometer/refl_options.py
deleted file mode 100644
index 29f9173769b18c44cbf146bbbd2e252695ebb2fc..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/refl_options.py
+++ /dev/null
@@ -1,99 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-# pylint: disable=invalid-name
-from __future__ import (absolute_import, division, print_function)
-from PyQt4 import QtCore, QtGui
-from ui.reflectometer.ui_refl_options_window import Ui_OptionsDialog
-
-try:
- _fromUtf8 = QtCore.QString.fromUtf8
-except AttributeError:
- def _fromUtf8(s):
- return s
-
-
-class ReflOptions(QtGui.QDialog, Ui_OptionsDialog):
- """
- Member variables
- """
- __frequency = 0
- __method = 0
- __method_list = ["Add", "Replace", "Append"]
- __icat_download = False
-
- def __init__(self, def_method, def_freq, def_alg_use, def_icat_download, def_group_tof_workspaces, def_stitch_right):
- """
- Initialise the interface
- """
- super(QtGui.QDialog, self).__init__()
-
- # Initialize member variables
- self.__alg_use = def_alg_use
- self.__method = def_method
- self.__frequency = def_freq
- self.__icat_download = def_icat_download
- self.__group_tof_workspaces = def_group_tof_workspaces
- self.__stitch_right = def_stitch_right
-
- self.setupUi(self)
-
- # Setup UI controls
- self.comboAccMethod.addItems(self.__method_list)
- if def_method in self.__method_list:
- self.comboAccMethod.setCurrentIndex(self.__method_list.index(def_method))
- else:
- self.comboAccMethod.setCurrentIndex(0)
-
- self.dspinFrequency.setValue(def_freq)
- self.checkAlg.setChecked(def_alg_use)
- self.checkICATDownload.setChecked(def_icat_download)
- self.checkGroupTOFWorkspaces.setChecked(def_group_tof_workspaces)
- self.checkScaleRight.setChecked(def_stitch_right)
-
- # connect update signals to functions
- self.dspinFrequency.valueChanged.connect(self.__update_frequency)
- self.comboAccMethod.activated.connect(self.__update_method)
- self.checkAlg.clicked.connect(self.__update_Alg_use)
- self.checkICATDownload.clicked.connect(self.__update_download_method)
- self.checkGroupTOFWorkspaces.clicked.connect(self.__update_groupTOF_method)
- self.checkScaleRight.clicked.connect(self.__update_stitch_right)
-
- def __update_Alg_use(self, checked):
- self.__alg_use = checked
-
- def __update_frequency(self, freq):
- self.__frequency = freq
-
- def __update_method(self, meth):
- self.__method = meth
-
- def __update_download_method(self, checked):
- self.__icat_download = checked
-
- def __update_groupTOF_method(self, checked):
- self.__group_tof_workspaces = checked
-
- def __update_stitch_right(self, checked):
- self.__stitch_right = checked
-
- def icatDownload(self):
- return self.__icat_download
-
- def groupTOFWorkspaces(self):
- return self.__group_tof_workspaces
-
- def frequency(self):
- return self.__frequency
-
- def useAlg(self):
- return self.__alg_use
-
- def method(self):
- return self.__method
-
- def stitchRight(self):
- return self.__stitch_right
diff --git a/scripts/Interface/ui/reflectometer/refl_options_window.ui b/scripts/Interface/ui/reflectometer/refl_options_window.ui
deleted file mode 100644
index e97bde254bb782f75cdb5fd23e9e0d9e299e6988..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/refl_options_window.ui
+++ /dev/null
@@ -1,131 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>OptionsDialog</class>
- <widget class="QDialog" name="OptionsDialog">
- <property name="geometry">
- <rect>
- <x>0</x>
- <y>0</y>
- <width>332</width>
- <height>194</height>
- </rect>
- </property>
- <property name="windowTitle">
- <string>Refl Gui Options</string>
- </property>
- <layout class="QFormLayout" name="layoutLive">
- <property name="fieldGrowthPolicy">
- <enum>QFormLayout::AllNonFixedFieldsGrow</enum>
- </property>
- <item row="0" column="0">
- <widget class="QLabel" name="labelAccMethod">
- <property name="text">
- <string>Accumulation Method</string>
- </property>
- <property name="buddy">
- <cstring>comboAccMethod</cstring>
- </property>
- </widget>
- </item>
- <item row="0" column="1">
- <widget class="QComboBox" name="comboAccMethod"/>
- </item>
- <item row="1" column="0">
- <widget class="QLabel" name="labelFrequency">
- <property name="text">
- <string>Update Every</string>
- </property>
- <property name="buddy">
- <cstring>dspinFrequency</cstring>
- </property>
- </widget>
- </item>
- <item row="1" column="1">
- <widget class="QDoubleSpinBox" name="dspinFrequency">
- <property name="singleStep">
- <double>0.500000000000000</double>
- </property>
- </widget>
- </item>
- <item row="2" column="0" colspan="2">
- <widget class="QCheckBox" name="checkAlg">
- <property name="text">
- <string>Use ReflectometryReductionOneAuto Algorithm</string>
- </property>
- </widget>
- </item>
- <item row="3" column="0" colspan="2">
- <widget class="QCheckBox" name="checkICATDownload">
- <property name="text">
- <string>Download Files Using ICAT</string>
- </property>
- </widget>
- </item>
- <item row="4" column="0" colspan="2">
- <widget class="QCheckBox" name="checkGroupTOFWorkspaces">
- <property name="text">
- <string>Group TOF Workspaces</string>
- </property>
- </widget>
- </item>
- <item row="6" column="0" colspan="2">
- <widget class="QDialogButtonBox" name="buttonsLive">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="standardButtons">
- <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
- </property>
- </widget>
- </item>
- <item row="5" column="0">
- <widget class="QCheckBox" name="checkScaleRight">
- <property name="toolTip">
- <string>Deselecting this will scale the LHS workspace</string>
- </property>
- <property name="text">
- <string>Scale Right Workspace When Stitching</string>
- </property>
- <property name="checked">
- <bool>true</bool>
- </property>
- </widget>
- </item>
- </layout>
- </widget>
- <resources/>
- <connections>
- <connection>
- <sender>buttonsLive</sender>
- <signal>accepted()</signal>
- <receiver>OptionsDialog</receiver>
- <slot>accept()</slot>
- <hints>
- <hint type="sourcelabel">
- <x>248</x>
- <y>254</y>
- </hint>
- <hint type="destinationlabel">
- <x>157</x>
- <y>274</y>
- </hint>
- </hints>
- </connection>
- <connection>
- <sender>buttonsLive</sender>
- <signal>rejected()</signal>
- <receiver>OptionsDialog</receiver>
- <slot>reject()</slot>
- <hints>
- <hint type="sourcelabel">
- <x>316</x>
- <y>260</y>
- </hint>
- <hint type="destinationlabel">
- <x>286</x>
- <y>274</y>
- </hint>
- </hints>
- </connection>
- </connections>
-</ui>
diff --git a/scripts/Interface/ui/reflectometer/refl_save.py b/scripts/Interface/ui/reflectometer/refl_save.py
deleted file mode 100644
index 02cbd51a1b59c491c2c9e9261a02a5b25e239a15..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/refl_save.py
+++ /dev/null
@@ -1,435 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-#pylint: disable-all
-from __future__ import (absolute_import, division, print_function)
-from PyQt4 import QtCore, QtGui
-import os
-from mantid.simpleapi import *
-from mantid.api import WorkspaceGroup, AnalysisDataService
-import xml.etree.ElementTree as xml
-from isis_reflectometry.quick import *
-from isis_reflectometry.procedures import *
-from isis_reflectometry.combineMulti import *
-from isis_reflectometry.saveModule import *
-from isis_reflectometry.settings import Settings
-
-try:
- _fromUtf8 = QtCore.QString.fromUtf8
-except AttributeError:
- def _fromUtf8(s):
- return s
-
-
-class Ui_SaveWindow(object):
- def __init__(self):
-
- self.__has_mount_point = True
-
- self.__instrument = config['default.instrument'].strip().upper()
-
- try:
- usersettings = Settings() # This will throw a missing config exception if no config file is available.
- self.__mountpoint = usersettings.get_named_setting("DataMountPoint")
- except KeyError:
- print("DataMountPoint is missing from the config.xml file.")
- self.__has_mount_point = False
-
- def setupUi(self, SaveWindow):
- self.SavePath=""
- SaveWindow.setObjectName(_fromUtf8("SaveWindow"))
- SaveWindow.setSizePolicy(QtGui.QSizePolicy(QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Expanding))
- SaveWindow.setAcceptDrops(True)
- main_layout = QtGui.QHBoxLayout()
- SaveWindow.setLayout(main_layout)
- self.centralWidget = QtGui.QWidget(SaveWindow)
- main_layout.addWidget(self.centralWidget)
- self.centralWidget.setObjectName(_fromUtf8("centralWidget"))
- self.gridLayout_2 = QtGui.QGridLayout(self.centralWidget)
- self.gridLayout_2.setObjectName(_fromUtf8("gridLayout_2"))
- self.gridLayout = QtGui.QGridLayout()
- self.gridLayout.setSizeConstraint(QtGui.QLayout.SetNoConstraint)
- self.gridLayout.setObjectName(_fromUtf8("gridLayout"))
-
-# Path label and edit field
- self.PathLabel = QtGui.QLabel("Save path: ",self.centralWidget)
- self.gridLayout.addWidget(self.PathLabel,0,2,1,1)
- self.lineEdit = QtGui.QLineEdit(self.centralWidget)
- font = QtGui.QFont()
- font.setWeight(75)
- font.setBold(False)
- self.lineEdit.setFont(font)
- self.lineEdit.setObjectName(_fromUtf8("lineEdit"))
- self.gridLayout.addWidget(self.lineEdit, 0, 3, 1, 3)
- #print(QtGui.QMainWindow.findChild(QtGui.QMainWindow.QLabel,'RBEdit'))
-
-# Prefix label and edit field
- self.PrefixLabel = QtGui.QLabel("Prefix: ",self.centralWidget)
- self.gridLayout.addWidget(self.PrefixLabel,0,6,1,1)
- self.lineEdit2 = QtGui.QLineEdit(self.centralWidget)
- self.lineEdit2.setFont(font)
- self.lineEdit2.setObjectName(_fromUtf8("lineEdit2"))
- self.gridLayout.addWidget(self.lineEdit2, 0, 7, 1, 2)
-
- sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed)
- sizePolicy.setHorizontalStretch(0)
- sizePolicy.setVerticalStretch(0)
- sizePolicy.setHeightForWidth(self.lineEdit.sizePolicy().hasHeightForWidth())
- self.lineEdit.setSizePolicy(sizePolicy)
- self.lineEdit2.setSizePolicy(sizePolicy)
- self.filterLabel = QtGui.QLabel("Filter: ",self.centralWidget)
- self.gridLayout.addWidget(self.filterLabel,1,2,1,1)
- self.filterEdit = QtGui.QLineEdit(self.centralWidget)
- self.filterEdit.setFont(font)
- self.filterEdit.setObjectName(_fromUtf8("filterEdit"))
- self.gridLayout.addWidget(self.filterEdit, 1, 3, 1, 1)
-
- self.regExCheckBox = QtGui.QCheckBox("RegEx", self.centralWidget)
- self.gridLayout.addWidget(self.regExCheckBox, 1, 4, 1, 1)
-
- self.LogsLabel = QtGui.QLabel("List of logged parameters: ",self.centralWidget)
- self.gridLayout.addWidget(self.LogsLabel,1,6,1,3)
-
- self.ListLabel = QtGui.QLabel("List of workspaces: ",self.centralWidget)
-
-# List of workspaces
- self.listWidget = QtGui.QListWidget(self.centralWidget)
- self.listWidget.setSelectionMode(QtGui.QAbstractItemView.ExtendedSelection)
- sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Expanding)
- sizePolicy.setHorizontalStretch(0)
- sizePolicy.setVerticalStretch(0)
- sizePolicy.setHeightForWidth(self.listWidget.sizePolicy().hasHeightForWidth())
-
- self.workspacesLayout = QtGui.QBoxLayout(QtGui.QBoxLayout.TopToBottom)
- self.workspacesLayout.addWidget(self.ListLabel)
- self.workspacesLayout.addWidget(self.listWidget)
- self.gridLayout.addLayout(self.workspacesLayout,2,2,1,3)
-
-# List of Logged Parameters
- self.listWidget2 = QtGui.QListWidget(self.centralWidget)
- self.listWidget2.setSelectionMode(QtGui.QAbstractItemView.ExtendedSelection)
- sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Expanding)
- sizePolicy.setHorizontalStretch(0)
- sizePolicy.setVerticalStretch(0)
- sizePolicy.setHeightForWidth(self.listWidget.sizePolicy().hasHeightForWidth())
- self.gridLayout.addWidget(self.listWidget2, 2, 6, 1, 3)
-
- spacerItem = QtGui.QSpacerItem(20, 20, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Minimum)
- self.gridLayout.addItem(spacerItem, 2, 5, 1, 1)
- spacerItem1 = QtGui.QSpacerItem(20, 20, QtGui.QSizePolicy.Minimum, QtGui.QSizePolicy.Fixed)
- self.gridLayout.addItem(spacerItem1, 4, 2, 1, 1)
- spacerItem2 = QtGui.QSpacerItem(20, 20, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Minimum)
- self.gridLayout.addItem(spacerItem2, 2, 0, 1, 1)
- self.pushButton = QtGui.QPushButton(self.centralWidget)
-
-# Save Title
- self.titleCheckBox = QtGui.QCheckBox("Title", self.centralWidget)
- #self.gridLayout.addWidget(self.titleCheckBox, 3, 6, 1, 1)
-
-# Tab check box
- #self.tabCheckBox = QtGui.QCheckBox("tab", self.centralWidget)
- #self.gridLayout.addWidget(self.titleCheckBox, 3, 6, 1, 1)
-
-# Comma check box
- #self.commaCheckBox = QtGui.QCheckBox("comma", self.centralWidget)
- #self.gridLayout.addWidget(self.commaCheckBox, 3, 6, 1, 1)
-
-
-# Space check box
- #self.spaceCheckBox = QtGui.QCheckBox("space", self.centralWidget)
- #self.gridLayout.addWidget(self.commaCheckBox, 3, 6, 1, 1)
-
-# Save XError
- self.xErrorCheckBox = QtGui.QCheckBox("Q resolution", self.centralWidget)
- #self.gridLayout.addWidget(self.xErrorCheckBox, 3, 7, 1, 1)
-
-# separator
- #self.separatorLabel = QtGui.QLabel("Separator: ", self.centralWidget)
- #self.gridLayout.addWidget(self.separatorLabel,4,6,1,1)
- #self.separatorEdit = QtGui.QLineEdit(self.centralWidget)
- #self.separatorEdit.setObjectName(_fromUtf8("separatorEdit"))
- #self.gridLayout.addWidget(self.separatorEdit, 4, 7, 1, 1)
-
- self.groupBox = QtGui.QGroupBox("Custom format options")
- self.vbox = QtGui.QVBoxLayout()
- self.hbox = QtGui.QHBoxLayout()
- self.vbox.addWidget(self.titleCheckBox)
- self.vbox.addWidget(self.xErrorCheckBox)
-
- self.groupBox2 = QtGui.QGroupBox("Separator")
- #self.buttonGroup=QtGui.QButtonGroup("Separator:", self.groupBox)
- self.radio1=QtGui.QRadioButton("Comma", self.centralWidget)
- self.radio2=QtGui.QRadioButton("Space", self.centralWidget)
- self.radio3=QtGui.QRadioButton("Tab", self.centralWidget)
-
- self.radio1.setChecked(1)
- self.hbox.addWidget(self.radio1)
- self.hbox.addWidget(self.radio2)
- self.hbox.addWidget(self.radio3)
- self.groupBox2.setLayout(self.hbox)
- # self.hbox.addWidget(self.separatorLabel)
- # self.hbox.addWidget(self.commaCheckBox)
- # self.hbox.addWidget(self.spaceCheckBox)
- # self.hbox.addWidget(self.tabCheckBox)
-
- self.vbox.addWidget(self.groupBox2)
- self.vbox.addStretch(1)
- #self.groupBox.setCheckable(1)
- self.groupBox.setLayout(self.vbox)
- self.gridLayout.addWidget(self.groupBox, 3, 6, 3, 3)
-
-# spectralist
- self.spectraLabel = QtGui.QLabel("Spectra list: ", self.centralWidget)
- self.gridLayout.addWidget(self.spectraLabel,4,2,1,1)
- self.spectraEdit = QtGui.QLineEdit(self.centralWidget)
- self.spectraEdit.setObjectName(_fromUtf8("spectraEdit"))
- self.gridLayout.addWidget(self.spectraEdit, 4, 3, 1, 1)
-
-# file format selector
- self.fileFormatLabel = QtGui.QLabel("File format: ", self.centralWidget)
- self.gridLayout.addWidget(self.fileFormatLabel,5,2,1,1)
- self.comboBox = QtGui.QComboBox(self.centralWidget)
- self.comboBox.setToolTip("Please select the file format")
- self.comboBox.setStatusTip("Please select the file format")
- sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed)
- sizePolicy.setHorizontalStretch(0)
- sizePolicy.setVerticalStretch(0)
- sizePolicy.setHeightForWidth(self.comboBox.sizePolicy().hasHeightForWidth())
- self.comboBox.setSizePolicy(sizePolicy)
- font = QtGui.QFont()
- font.setWeight(75)
- font.setBold(True)
- self.comboBox.setFont(font)
- self.comboBox.setObjectName(_fromUtf8("comboBox"))
- self.comboBox.addItem(_fromUtf8("Custom format (*.dat)"))
- self.comboBox.addItem(_fromUtf8("3 column (*.dat)"))
- self.comboBox.addItem(_fromUtf8("ANSTO, MotoFit, 4 column (*.txt)"))
- self.comboBox.addItem(_fromUtf8("ILL Cosmos (*.mft)"))
- self.gridLayout.addWidget(self.comboBox, 5, 3, 1, 1)
-
- sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed)
- sizePolicy.setHorizontalStretch(0)
- sizePolicy.setVerticalStretch(0)
- sizePolicy.setHeightForWidth(self.pushButton.sizePolicy().hasHeightForWidth())
- self.pushButton.setSizePolicy(sizePolicy)
- self.pushButton.setObjectName(_fromUtf8("pushButton"))
- self.gridLayout.addWidget(self.pushButton, 8, 2, 1, 1)
- spacerItem3 = QtGui.QSpacerItem(20, 28, QtGui.QSizePolicy.Minimum, QtGui.QSizePolicy.Fixed)
- self.gridLayout.addItem(spacerItem3, 8, 3, 1, 1)
- self.pushButton_2 = QtGui.QPushButton(self.centralWidget)
- sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed)
- sizePolicy.setHorizontalStretch(0)
- sizePolicy.setVerticalStretch(0)
- sizePolicy.setHeightForWidth(self.pushButton_2.sizePolicy().hasHeightForWidth())
- self.pushButton_2.setSizePolicy(sizePolicy)
- self.pushButton_2.setObjectName(_fromUtf8("pushButton_2"))
- self.gridLayout.addWidget(self.pushButton_2, 8, 4, 1, 1)
-
- self.gridLayout_2.addLayout(self.gridLayout, 0, 0, 1, 1)
-
- self.retranslateUi(SaveWindow)
- self.populateList()
- #self.workspaceSelected()
- QtCore.QObject.connect(self.pushButton, QtCore.SIGNAL(_fromUtf8("clicked()")), self.buttonClickHandler1)
- QtCore.QObject.connect(self.pushButton_2, QtCore.SIGNAL(_fromUtf8("clicked()")), self.populateList)
- QtCore.QObject.connect(self.lineEdit, QtCore.SIGNAL(_fromUtf8("textChanged()")), self.setPath)
- QtCore.QObject.connect(self.filterEdit, QtCore.SIGNAL(_fromUtf8("textChanged(QString)")), self.filterWksp)
- QtCore.QObject.connect(self.listWidget, QtCore.SIGNAL(_fromUtf8("itemActivated(QListWidgetItem*)")), self.workspaceSelected)
- # QtCore.QObject.connect(self.actionSave_table, QtCore.SIGNAL(_fromUtf8("triggered()")), self.saveDialog)
- # QtCore.QObject.connect(self.actionLoad_table, QtCore.SIGNAL(_fromUtf8("triggered()")), self.loadDialog)
- QtCore.QMetaObject.connectSlotsByName(SaveWindow)
-
- def retranslateUi(self, SaveWindow):
- SaveWindow.setWindowTitle(QtGui.QApplication.translate("SaveWindow", "SaveWindow", None, QtGui.QApplication.UnicodeUTF8))
- self.pushButton.setText(QtGui.QApplication.translate("SaveWindow", "Save", None, QtGui.QApplication.UnicodeUTF8))
- self.pushButton_2.setText(QtGui.QApplication.translate("SaveWindow", "Refresh", None, QtGui.QApplication.UnicodeUTF8))
-
- def _get_saveable_workspace_names(self):
- names = mtd.getObjectNames()
- # Exclude WorkspaceGroups from our list. We cannot save them to ASCII.
- names = [i for i in names if not isinstance(AnalysisDataService.retrieve(i), WorkspaceGroup)]
- return names
-
- def filterWksp(self):
- self.listWidget.clear()
- names = self._get_saveable_workspace_names()
- if self.regExCheckBox.isChecked():
- regex=re.compile(self.filterEdit.text())
- filtered = list()
- for w in names:
- match = regex.search(w)
- if match:
- filtered.append( match.string )
- newList = filtered
- else:
- newList=filter(lambda k: self.filterEdit.text() in k, names)
-
- self.listWidget.insertItems(0, newList)
-
- def setPath():
- self.SavePath=self.lineEdit.text()
-
- def workspaceSelected(self):
- self.listWidget2.clear()
- #self.listWidget.setCurrentRow(0)
- print(str(self.listWidget.currentItem().text()))
- logs = mtd[str(self.listWidget.currentItem().text())].getRun().getLogData()
- for i in range(0,len(logs)):
- self.listWidget2.addItem(logs[i].name)
-
- def populateList(self):
- self.listWidget.clear()
- names = self._get_saveable_workspace_names()
- if len(names):
- RB_Number=groupGet(names[0],'samp','rb_proposal')
- for ws in names:
- self.listWidget.addItem(ws)
-
- self.listWidget.setCurrentItem(self.listWidget.item(0))
- # try to get correct user directory
- if self.SavePath!='':
- self.lineEdit.setText(self.SavePath)
- else:
- if self.__has_mount_point:
- try:
- print("mountpoint = ", self.__mountpoint)
- base_path = os.path.join(self.__mountpoint, 'NDX'+ self.__instrument, 'Instrument','logs','journal')
- print("Loading journal from", base_path)
- main_journal_path = os.path.join(base_path, 'journal_main.xml')
- tree1=xml.parse(main_journal_path)
- root1=tree1.getroot()
- currentJournal=root1[len(root1)-1].attrib.get('name')
- cycle_journal_path = os.path.join(base_path, currentJournal)
- tree=xml.parse(cycle_journal_path)
- root=tree.getroot()
- i=0
- try:
- while root[i][4].text!=str(RB_Number):
- i+=1
- if root[i][1].text.find(',')>0:
- user=root[i][1].text[0:root[i][1].text.find(',')]
- else:
- user=root[i][1].text[0:root[i][1].text.find(' ')]
- SavePath = os.path.join('U:/', user)
- self.lineEdit.setText(SavePath)
- except LookupError:
- print("Couldn't find user name in archives!")
- except:
- print("Journal does not exist or is unreachable, please check your network connection.")
-
-#--------- If "Save" button pressed, selected workspaces are saved -------------
- def buttonClickHandler1(self):
- prefix = str(self.lineEdit2.text())
- if not (self.lineEdit.text() and os.path.exists(self.lineEdit.text())):
- logger.notice("Directory specified doesn't exist or was invalid for your operating system")
- QtGui.QMessageBox.critical(self.lineEdit, 'Could not save',
- "Directory specified doesn't exist or was invalid for your operating system")
- return
- for idx in self.listWidget.selectedItems():
- fname=os.path.join(self.lineEdit.text(),prefix + idx.text())
- if self.comboBox.currentIndex() == 0:
- print("Custom Ascii format")
- if self.radio1.isChecked():
- sep=','
- elif self.radio2.isChecked():
- sep=' '
- elif self.radio3.isChecked():
- sep='\t'
- else:
- sep=' '
- saveCustom(idx,fname,sep,self.listWidget2.selectedItems(),self.titleCheckBox.isChecked(),self.xErrorCheckBox.isChecked())
- elif self.comboBox.currentIndex() == 1:
- print("Not yet implemented!")
- elif self.comboBox.currentIndex() == 2:
- print("ANSTO format")
- saveANSTO(idx,fname)
- elif self.comboBox.currentIndex() == 3:
- print("ILL MFT format")
- saveMFT(idx,fname,self.listWidget2.selectedItems())
- # for idx in self.listWidget.selectedItems():
- # fname=str(path+prefix+idx.text()+'.dat')
- # print("FILENAME: ", fname)
- # wksp=str(idx.text())
- # SaveAscii(InputWorkspace=wksp,Filename=fname)
-
- self.SavePath=self.lineEdit.text()
-
-
-def calcRes(run):
- runno = '_' + str(run) + 'temp'
- if isinstance(run, type(int())):
- Load(Filename=run, OutputWorkspace=runno)
- else:
- Load(Filename=run.replace("raw", "nxs", 1), OutputWorkspace=runno)
- # Get slits and detector angle theta from NeXuS
- theta = groupGet(runno, 'samp', 'THETA')
- inst = groupGet(runno, 'inst')
- s1z = inst.getComponentByName('slit1').getPos().getZ() * 1000.0 # distance in mm
- s2z = inst.getComponentByName('slit2').getPos().getZ() * 1000.0 # distance in mm
- s1vg = inst.getComponentByName('slit1')
- s1vg = s1vg.getNumberParameter('vertical gap')[0]
- s2vg = inst.getComponentByName('slit2')
- s2vg = s2vg.getNumberParameter('vertical gap')[0]
-
- if not isinstance(theta, float):
- th = theta[len(theta) - 1]
- else:
- th = theta
-
- print("s1vg=", s1vg, "s2vg=", s2vg, "theta=", theta)
- #1500.0 is the S1-S2 distance in mm for SURF!!!
- resolution = math.atan((s1vg + s2vg) / (2 * (s2z - s1z))) * 180 / math.pi / th
- print("dq/q=", resolution)
- DeleteWorkspace(runno)
- return resolution
-
-
-def groupGet(wksp, whattoget, field=''):
- '''
- returns information about instrument or sample details for a given workspace wksp,
- also if the workspace is a group (info from first group element)
- '''
- if whattoget == 'inst':
- if isinstance(mtd[wksp], WorkspaceGroup):
- return mtd[wksp + '_1'].getInstrument()
- else:
- return mtd[wksp].getInstrument()
- elif whattoget == 'samp' and field != '':
- if isinstance(mtd[wksp], WorkspaceGroup):
- try:
- log = mtd[wksp + '_1'].getRun().getLogData(field).value
- if isinstance(log, int) or isinstance(log, str):
- res = log
- else:
- res = log[len(log) - 1]
- except RuntimeError:
- res = 0
- print("Block " + field + " not found.")
- else:
- try:
- log = mtd[wksp].getRun().getLogData(field).value
- if isinstance(log, int) or isinstance(log, str):
- res = log
- else:
- res = log[len(log) - 1]
- except RuntimeError:
- res = 0
- print("Block " + field + " not found.")
- return res
- elif whattoget == 'wksp':
- if isinstance(mtd[wksp], WorkspaceGroup):
- return mtd[wksp + '_1'].getNumberHistograms()
- else:
- return mtd[wksp].getNumberHistograms()
-
-
-def getWorkspace(wksp):
-
- if isinstance(mtd[wksp], WorkspaceGroup):
- wout = mtd[wksp + '_1']
- else:
- wout = mtd[wksp]
- return wout
diff --git a/scripts/Interface/ui/reflectometer/refl_window.ui b/scripts/Interface/ui/reflectometer/refl_window.ui
deleted file mode 100644
index a0709949d0fbfdd883b4aee9e2d16083c24331be..0000000000000000000000000000000000000000
--- a/scripts/Interface/ui/reflectometer/refl_window.ui
+++ /dev/null
@@ -1,842 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>windowRefl</class>
- <widget class="QMainWindow" name="windowRefl">
- <property name="geometry">
- <rect>
- <x>0</x>
- <y>0</y>
- <width>1000</width>
- <height>400</height>
- </rect>
- </property>
- <property name="acceptDrops">
- <bool>true</bool>
- </property>
- <property name="windowTitle">
- <string>ISIS Reflectometry (Old) - DEPRECATED</string>
- </property>
- <widget class="QWidget" name="widgetMainRow">
- <layout class="QVBoxLayout" name="layoutBase">
- <item>
- <layout class="QHBoxLayout" name="layoutTopRow">
- <item>
- <widget class="QLabel" name="labelInstrument">
- <property name="text">
- <string>Instrument:</string>
- </property>
- <property name="buddy">
- <cstring>comboInstrument</cstring>
- </property>
- </widget>
- </item>
- <item>
- <widget class="QComboBox" name="comboInstrument">
- <property name="sizePolicy">
- <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
- <horstretch>0</horstretch>
- <verstretch>0</verstretch>
- </sizepolicy>
- </property>
- <property name="font">
- <font>
- <weight>75</weight>
- <bold>true</bold>
- </font>
- </property>
- <property name="toolTip">
- <string>Sets the instrument to use.</string>
- </property>
- </widget>
- </item>
- <item>
- <spacer name="spacer_2">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="sizeHint" stdset="0">
- <size>
- <width>40</width>
- <height>20</height>
- </size>
- </property>
- </spacer>
- </item>
- <item>
- <widget class="QLabel" name="labelRuns">
- <property name="text">
- <string>Transmission run(s):</string>
- </property>
- <property name="buddy">
- <cstring>textRuns</cstring>
- </property>
- </widget>
- </item>
- <item>
- <widget class="QLineEdit" name="textRuns">
- <property name="minimumSize">
- <size>
- <width>90</width>
- <height>0</height>
- </size>
- </property>
- <property name="maximumSize">
- <size>
- <width>120</width>
- <height>16777215</height>
- </size>
- </property>
- <property name="toolTip">
- <string>Transmission run number to be automatically entered into the 'trans' column when transferring runs.</string>
- </property>
- </widget>
- </item>
- <item>
- <spacer name="horizontalSpacer_2">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="sizeHint" stdset="0">
- <size>
- <width>40</width>
- <height>20</height>
- </size>
- </property>
- </spacer>
- </item>
- <item>
- <widget class="QLabel" name="labelPolarCorrect">
- <property name="text">
- <string>Polarisation corrections:</string>
- </property>
- <property name="buddy">
- <cstring>comboPolarCorrect</cstring>
- </property>
- </widget>
- </item>
- <item>
- <widget class="QComboBox" name="comboPolarCorrect">
- <property name="font">
- <font>
- <weight>75</weight>
- <bold>true</bold>
- </font>
- </property>
- <property name="toolTip">
- <string>Sets the polarisation corrections to be done when processing.</string>
- </property>
- <item>
- <property name="text">
- <string>None</string>
- </property>
- </item>
- <item>
- <property name="text">
- <string>1-PNR</string>
- </property>
- </item>
- <item>
- <property name="text">
- <string>2-PA</string>
- </property>
- </item>
- </widget>
- </item>
- <item>
- <spacer name="horizontalSpacer_3">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="sizeHint" stdset="0">
- <size>
- <width>40</width>
- <height>20</height>
- </size>
- </property>
- </spacer>
- </item>
- <item>
- <widget class="QPushButton" name="buttonColumns">
- <property name="text">
- <string>Choose Columns...</string>
- </property>
- </widget>
- </item>
- </layout>
- </item>
- <item>
- <layout class="QHBoxLayout" name="layoutMidRow">
- <property name="spacing">
- <number>12</number>
- </property>
- <item>
- <widget class="QLabel" name="labelRB">
- <property name="text">
- <string>RB Search:</string>
- </property>
- <property name="buddy">
- <cstring>textRB</cstring>
- </property>
- </widget>
- </item>
- <item>
- <widget class="QLineEdit" name="textRB">
- <property name="minimumSize">
- <size>
- <width>40</width>
- <height>0</height>
- </size>
- </property>
- <property name="maximumSize">
- <size>
- <width>70</width>
- <height>16777215</height>
- </size>
- </property>
- <property name="toolTip">
- <string>The term to search the archives for</string>
- </property>
- <property name="inputMethodHints">
- <set>Qt::ImhDigitsOnly</set>
- </property>
- <property name="cursorPosition">
- <number>0</number>
- </property>
- </widget>
- </item>
- <item>
- <widget class="QPushButton" name="buttonSearch">
- <property name="text">
- <string>Search</string>
- </property>
- </widget>
- </item>
- <item>
- <spacer name="horizontalSpacer">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="sizeHint" stdset="0">
- <size>
- <width>40</width>
- <height>20</height>
- </size>
- </property>
- </spacer>
- </item>
- <item>
- <widget class="QCheckBox" name="checkTickAll">
- <property name="toolTip">
- <string>Toggles selection of the 'Stitch?' column.</string>
- </property>
- <property name="layoutDirection">
- <enum>Qt::LeftToRight</enum>
- </property>
- <property name="text">
- <string>(un)tick all</string>
- </property>
- <property name="tristate">
- <bool>false</bool>
- </property>
- </widget>
- </item>
- <item>
- <spacer name="spacer_3">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="sizeHint" stdset="0">
- <size>
- <width>40</width>
- <height>20</height>
- </size>
- </property>
- </spacer>
- </item>
- <item>
- <widget class="QPushButton" name="buttonAuto">
- <property name="text">
- <string>AutoFill</string>
- </property>
- </widget>
- </item>
- </layout>
- </item>
- <item>
- <widget class="QSplitter" name="splitterList">
- <property name="sizePolicy">
- <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
- <horstretch>0</horstretch>
- <verstretch>0</verstretch>
- </sizepolicy>
- </property>
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
- </property>
- <property name="childrenCollapsible">
- <bool>false</bool>
- </property>
- <widget class="QListWidget" name="listMain">
- <property name="sizePolicy">
- <sizepolicy hsizetype="Preferred" vsizetype="Expanding">
- <horstretch>0</horstretch>
- <verstretch>0</verstretch>
- </sizepolicy>
- </property>
- <property name="minimumSize">
- <size>
- <width>100</width>
- <height>0</height>
- </size>
- </property>
- <property name="maximumSize">
- <size>
- <width>500</width>
- <height>16777215</height>
- </size>
- </property>
- <property name="baseSize">
- <size>
- <width>199</width>
- <height>0</height>
- </size>
- </property>
- <property name="selectionMode">
- <enum>QAbstractItemView::ExtendedSelection</enum>
- </property>
- </widget>
- <widget class="QWidget" name="widgetBottomRight">
- <layout class="QHBoxLayout" name="layoutBottomRow">
- <item>
- <widget class="QPushButton" name="buttonTransfer">
- <property name="sizePolicy">
- <sizepolicy hsizetype="Fixed" vsizetype="Expanding">
- <horstretch>0</horstretch>
- <verstretch>0</verstretch>
- </sizepolicy>
- </property>
- <property name="maximumSize">
- <size>
- <width>25</width>
- <height>16777215</height>
- </size>
- </property>
- <property name="text">
- <string>=></string>
- </property>
- </widget>
- </item>
- <item>
- <layout class="QVBoxLayout" name="layoutTableColumn">
- <item>
- <widget class="QTableWidget" name="tableMain">
- <property name="font">
- <font>
- <weight>50</weight>
- <bold>false</bold>
- </font>
- </property>
- <property name="editTriggers">
- <set>QAbstractItemView::AnyKeyPressed|QAbstractItemView::DoubleClicked|QAbstractItemView::EditKeyPressed|QAbstractItemView::SelectedClicked</set>
- </property>
- <property name="alternatingRowColors">
- <bool>true</bool>
- </property>
- <property name="selectionMode">
- <enum>QAbstractItemView::ContiguousSelection</enum>
- </property>
- <property name="rowCount">
- <number>100</number>
- </property>
- <property name="columnCount">
- <number>19</number>
- </property>
- <attribute name="horizontalHeaderCascadingSectionResizes">
- <bool>false</bool>
- </attribute>
- <attribute name="horizontalHeaderDefaultSectionSize">
- <number>60</number>
- </attribute>
- <attribute name="horizontalHeaderMinimumSectionSize">
- <number>20</number>
- </attribute>
- <attribute name="horizontalHeaderStretchLastSection">
- <bool>false</bool>
- </attribute>
- <attribute name="verticalHeaderCascadingSectionResizes">
- <bool>false</bool>
- </attribute>
- <attribute name="verticalHeaderDefaultSectionSize">
- <number>20</number>
- </attribute>
- <attribute name="verticalHeaderStretchLastSection">
- <bool>false</bool>
- </attribute>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <row/>
- <column>
- <property name="text">
- <string>Run(s)</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>Angle 1</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>trans 1</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>qmin_1</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>qmax_1</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>Run(s)</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>Angle 2</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>trans 2</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>qmin_2</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>qmax_2</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>Run(s)</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>Angle 3</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>trans 3</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>qmin_3</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>qmax_3</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>dq/q</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>Scale</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>Stitch?</string>
- </property>
- </column>
- <column>
- <property name="text">
- <string>Plot?</string>
- </property>
- </column>
- </widget>
- </item>
- <item>
- <layout class="QHBoxLayout" name="layoutTableButton">
- <item>
- <widget class="QPushButton" name="buttonProcess">
- <property name="sizePolicy">
- <sizepolicy hsizetype="Expanding" vsizetype="Fixed">
- <horstretch>0</horstretch>
- <verstretch>0</verstretch>
- </sizepolicy>
- </property>
- <property name="text">
- <string>Process</string>
- </property>
- </widget>
- </item>
- <item>
- <widget class="QPushButton" name="buttonClear">
- <property name="text">
- <string>Clear all</string>
- </property>
- </widget>
- </item>
- </layout>
- </item>
- </layout>
- </item>
- </layout>
- </widget>
- </widget>
- </item>
- </layout>
- <zorder>splitterList</zorder>
- <zorder></zorder>
- <zorder></zorder>
- </widget>
- <widget class="QMenuBar" name="menuBar">
- <property name="geometry">
- <rect>
- <x>0</x>
- <y>0</y>
- <width>1000</width>
- <height>23</height>
- </rect>
- </property>
- <widget class="QMenu" name="menuFile">
- <property name="title">
- <string>File</string>
- </property>
- <addaction name="actionOpen_Table"/>
- <addaction name="actionReload_from_Disk"/>
- <addaction name="separator"/>
- <addaction name="actionSave"/>
- <addaction name="actionSave_As"/>
- <addaction name="actionSave_Workspaces"/>
- <addaction name="separator"/>
- <addaction name="actionClose_Refl_Gui"/>
- </widget>
- <widget class="QMenu" name="menuHelp">
- <property name="title">
- <string>Help</string>
- </property>
- <addaction name="actionMantid_Help"/>
- <addaction name="actionSlit_Calculator"/>
- </widget>
- <widget class="QMenu" name="menuFunction">
- <property name="title">
- <string>Function</string>
- </property>
- <addaction name="actionTransfer"/>
- <addaction name="actionAutofill"/>
- <addaction name="separator"/>
- <addaction name="actionProcess"/>
- <addaction name="actionClear_Table"/>
- <addaction name="separator"/>
- <addaction name="actionSearch_RB"/>
- </widget>
- <widget class="QMenu" name="menuEdit">
- <property name="title">
- <string>Edit</string>
- </property>
- <addaction name="actionCopy"/>
- <addaction name="actionCut"/>
- <addaction name="actionPaste"/>
- <addaction name="actionClear"/>
- </widget>
- <widget class="QMenu" name="menuOptions">
- <property name="title">
- <string>Options</string>
- </property>
- <addaction name="actionChoose_Columns"/>
- <addaction name="actionRefl_Gui_Options"/>
- </widget>
- <addaction name="menuFile"/>
- <addaction name="menuEdit"/>
- <addaction name="menuOptions"/>
- <addaction name="menuFunction"/>
- <addaction name="menuHelp"/>
- </widget>
- <widget class="QStatusBar" name="statusMain">
- <property name="font">
- <font>
- <pointsize>11</pointsize>
- </font>
- </property>
- </widget>
- <action name="actionSave_As">
- <property name="text">
- <string>Save As...</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+Alt+S</string>
- </property>
- </action>
- <action name="actionOpen_Table">
- <property name="text">
- <string>Open Table...</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+O</string>
- </property>
- </action>
- <action name="actionReload_from_Disk">
- <property name="text">
- <string>Reload from Disk</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+R</string>
- </property>
- </action>
- <action name="actionSave_Workspaces">
- <property name="text">
- <string>Save Workspaces</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+Shift+S</string>
- </property>
- </action>
- <action name="actionMantid_Help">
- <property name="text">
- <string>Mantid Help</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+H</string>
- </property>
- </action>
- <action name="actionSave">
- <property name="text">
- <string>Save</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+S</string>
- </property>
- </action>
- <action name="actionClose_Refl_Gui">
- <property name="text">
- <string>Close Refl Gui</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+F4</string>
- </property>
- </action>
- <action name="actionAutofill">
- <property name="text">
- <string>Autofill</string>
- </property>
- <property name="shortcut">
- <string>Alt+A</string>
- </property>
- </action>
- <action name="actionProcess">
- <property name="text">
- <string>Process</string>
- </property>
- <property name="shortcut">
- <string>Alt+P</string>
- </property>
- </action>
- <action name="actionTransfer">
- <property name="text">
- <string>Transfer</string>
- </property>
- <property name="shortcut">
- <string>Alt+T</string>
- </property>
- </action>
- <action name="actionClear_Table">
- <property name="text">
- <string>Clear Table</string>
- </property>
- <property name="shortcut">
- <string>Alt+C</string>
- </property>
- </action>
- <action name="actionSearch_RB">
- <property name="text">
- <string>Search RB</string>
- </property>
- <property name="shortcut">
- <string>Alt+R</string>
- </property>
- </action>
- <action name="actionCopy">
- <property name="text">
- <string>Copy</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+C</string>
- </property>
- </action>
- <action name="actionPaste">
- <property name="text">
- <string>Paste</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+V</string>
- </property>
- </action>
- <action name="actionCut">
- <property name="text">
- <string>Cut</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+X</string>
- </property>
- </action>
- <action name="actionClear">
- <property name="text">
- <string>Clear</string>
- </property>
- <property name="shortcut">
- <string>Del</string>
- </property>
- </action>
- <action name="actionChoose_Columns">
- <property name="text">
- <string>Choose Columns...</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+M</string>
- </property>
- </action>
- <action name="actionRefl_Gui_Options">
- <property name="text">
- <string>Refl Gui Options...</string>
- </property>
- <property name="shortcut">
- <string>Ctrl+Shift+O</string>
- </property>
- </action>
- <action name="actionSlit_Calculator">
- <property name="text">
- <string>Slit Calculator</string>
- </property>
- </action>
- </widget>
- <tabstops>
- <tabstop>comboInstrument</tabstop>
- <tabstop>textRuns</tabstop>
- <tabstop>comboPolarCorrect</tabstop>
- <tabstop>textRB</tabstop>
- <tabstop>buttonSearch</tabstop>
- <tabstop>checkTickAll</tabstop>
- <tabstop>buttonAuto</tabstop>
- <tabstop>buttonTransfer</tabstop>
- <tabstop>tableMain</tabstop>
- <tabstop>buttonProcess</tabstop>
- <tabstop>buttonClear</tabstop>
- </tabstops>
- <resources/>
- <connections/>
-</ui>
diff --git a/scripts/Interface/ui/sans_isis/sans_data_processor_gui.py b/scripts/Interface/ui/sans_isis/sans_data_processor_gui.py
index 14e716affbb1692ef60736b5ab6c2beccf218147..3555cf034ea480fc6467b7b1f3f8ca2f0bcc6c0b 100644
--- a/scripts/Interface/ui/sans_isis/sans_data_processor_gui.py
+++ b/scripts/Interface/ui/sans_isis/sans_data_processor_gui.py
@@ -11,19 +11,19 @@
from __future__ import (absolute_import, division, print_function)
from abc import ABCMeta, abstractmethod
+
from qtpy import PYQT4
from qtpy.QtCore import QRegExp
from qtpy.QtGui import (QDoubleValidator, QIntValidator, QRegExpValidator)
from qtpy.QtWidgets import (QListWidgetItem, QMessageBox, QFileDialog, QMainWindow)
+from six import with_metaclass
+from mantid.kernel import (Logger, UsageService, FeatureType)
+from mantid.py3compat import Enum
from mantidqt import icons
from mantidqt.interfacemanager import InterfaceManager
from mantidqt.utils.qt import load_ui
from mantidqt.widgets import jobtreeview, manageuserdirectories
-from six import with_metaclass
-
-from mantid.kernel import (Logger, UsageService, FeatureType)
-from mantid.py3compat import Enum
from reduction_gui.reduction.scripter import execute_script
from sans.common.enums import (ReductionDimensionality, OutputMode, SaveType, SANSInstrument,
RangeStepType, ReductionMode, FitType)
@@ -32,6 +32,7 @@ from sans.gui_logic.gui_common import (get_reduction_mode_from_gui_selection,
get_string_for_gui_from_reduction_mode, GENERIC_SETTINGS,
load_file, load_property, set_setting,
get_instrument_from_gui_selection)
+from sans.gui_logic.models.RowEntries import RowEntries
from sans.gui_logic.models.SumRunsModel import SumRunsModel
from sans.gui_logic.presenter.add_runs_presenter import AddRunsPagePresenter
from ui.sans_isis.SANSSaveOtherWindow import SANSSaveOtherDialog
@@ -59,7 +60,13 @@ class SANSDataProcessorGui(QMainWindow,
INSTRUMENTS = None
VARIABLE = "Variable"
- MULTI_PERIOD_COLUMNS = [1, 3, 5, 7, 9, 11]
+ # This dictates the order displayed on the GUI
+ COLUMN_NAMES = ["Sample Scatter", "Sample Transmission", "Sample Direct",
+ "Can Scatter", "Can Transmission", "Can Direct", "Output Name", "User File",
+ "Sample Thickness", "Options", "Sample Shape", "Sample Height", "Sample Width",
+ "SSP", "STP", "SDP", "CSP", "CTP", "CDP"]
+
+ MULTI_PERIOD_COLUMNS = ["SSP", "STP", "SDP", "CSP", "CTP", "CDP"]
class RunTabListener(with_metaclass(ABCMeta, object)):
"""
@@ -111,7 +118,7 @@ class SANSDataProcessorGui(QMainWindow,
pass
@abstractmethod
- def on_data_changed(self, row, column, new_value, old_value):
+ def on_data_changed(self, index, row):
pass
@abstractmethod
@@ -186,6 +193,8 @@ class SANSDataProcessorGui(QMainWindow,
SANSInstrument.LARMOR,
SANSInstrument.ZOOM])
+ self._column_index_map = None
+
self.instrument = SANSInstrument.NO_INSTRUMENT
self.paste_button.setIcon(icons.get_icon("mdi.content-paste"))
@@ -276,7 +285,7 @@ class SANSDataProcessorGui(QMainWindow,
# --------------------------------------------------------------------------------------------------------------
# Main Tab
# --------------------------------------------------------------------------------------------------------------
- self.create_data_table(show_periods=False)
+ self.create_data_table()
self._setup_main_tab()
@@ -381,18 +390,14 @@ class SANSDataProcessorGui(QMainWindow,
self.wavelength_stacked_widget.setCurrentIndex(0)
self.wavelength_step_label.setText(u'Step [\u00c5^-1]')
- def create_data_table(self, show_periods):
+ def create_data_table(self):
# Delete an already existing table
if self.data_processor_table:
self.data_processor_table.setParent(None)
- self.data_processor_table = jobtreeview.JobTreeView(
- ["Sample Scatter", "ssp", "Sample Transmission", "stp", "Sample Direct", "sdp",
- "Can Scatter", "csp",
- "Can Transmission", "ctp", "Can Direct", "cdp", "Output Name", "User File",
- "Sample Thickness", "Sample Height", "Sample Width", "Sample Shape",
- "Options"]
- , self.cell(""), self)
+ self._column_index_map = {col_name: i for i, col_name in enumerate(self.COLUMN_NAMES)}
+ self.data_processor_table = jobtreeview.JobTreeView(self.COLUMN_NAMES, self.cell(""), self)
+ self.hide_period_columns()
# Default QTreeView size is too small
font = self.data_processor_table.font()
@@ -401,20 +406,13 @@ class SANSDataProcessorGui(QMainWindow,
self.data_processor_table.setRootIsDecorated(False)
- row_entry = [''] * 16
- self.add_row(row_entry)
- self._call_settings_listeners(lambda listener: listener.on_row_inserted(0, row_entry))
+ self.add_empty_row()
self.table_signals = \
jobtreeview.JobTreeViewSignalAdapter(self.data_processor_table, self)
# The signal adapter subscribes to events from the table
# and emits signals whenever it is notified.
- if show_periods:
- self.show_period_columns()
- else:
- self.hide_period_columns()
-
self.data_processor_widget_layout.addWidget(self.data_processor_table)
self.table_signals.cellTextChanged.connect(self._data_changed)
self.table_signals.rowInserted.connect(self._row_inserted)
@@ -426,6 +424,9 @@ class SANSDataProcessorGui(QMainWindow,
self.table_signals.pasteRowsRequested.connect(self._paste_rows_requested)
def cell(self, text):
+ # Cell will only accept strings
+ text = str(text) if text else ''
+
background_color = 'white'
border_thickness = 1
border_color = "black"
@@ -476,16 +477,14 @@ class SANSDataProcessorGui(QMainWindow,
def _data_changed(self, row_location, column, old_value, new_value):
row = row_location.rowRelativeToParent()
+ row_obj = self._convert_to_row_state(self.get_row(row_location))
+
self._call_settings_listeners(
- lambda listener: listener.on_data_changed(row, column, str(new_value), (old_value)))
+ lambda listener: listener.on_data_changed(row, row_obj))
def _row_inserted(self, row_location):
if row_location.depth() > 1:
self.data_processor_table.removeRowAt(row_location)
- else:
- index = row_location.rowRelativeToParent()
- row = self.get_row(row_location)
- self._call_settings_listeners(lambda listener: listener.on_row_inserted(index, row))
def _append_and_edit_at_child_row_requested(self):
self.data_processor_table.appendAndEditAtChildRow()
@@ -627,7 +626,6 @@ class SANSDataProcessorGui(QMainWindow,
"""
Load the batch file
"""
-
UsageService.registerFeatureUsage(FeatureType.Feature, ["ISIS SANS", "Loaded Batch File"], False)
load_file(self.batch_line_edit, "*.*", self.__generic_settings, self.__batch_file_key,
self.get_batch_file_path)
@@ -1025,7 +1023,7 @@ class SANSDataProcessorGui(QMainWindow,
@save_can.setter
def save_can(self, value):
- self._on_save_can_clicked.setChecked(value)
+ self._on_save_can_clicked(value)
@property
def progress_bar_minimum(self):
@@ -1113,7 +1111,8 @@ class SANSDataProcessorGui(QMainWindow,
@instrument.setter
def instrument(self, value):
- assert (isinstance(value, Enum))
+ assert (isinstance(value, Enum)), \
+ "Expected InstrumentEnum, got %r" % value
instrument_string = value.value
self.instrument_type.setText("{}".format(instrument_string))
self._instrument_changed()
@@ -2100,10 +2099,10 @@ class SANSDataProcessorGui(QMainWindow,
# Table interaction
# ----------------------------------------------------------------------------------------------
- def get_cell(self, row, column, convert_to=None):
+ def get_cell(self, row, column):
row_location = self.row([row])
value = self.data_processor_table.cellAt(row_location, column).contentText()
- return value if convert_to is None else convert_to(value)
+ return value
def set_cell(self, value, row, column):
value_as_str = str(value)
@@ -2111,14 +2110,17 @@ class SANSDataProcessorGui(QMainWindow,
cell.setContentText(value_as_str)
self.data_processor_table.setCellAt(row, column, cell)
- def change_row_color(self, color, row):
- row_location = self.row([row])
+ def change_row_color(self, color, row_index):
+ row_location = self.row([row_index])
cell_data = self.data_processor_table.cellsAt(row_location)
for index, cell in enumerate(cell_data):
cell.setBackgroundColor(color)
self.data_processor_table.setCellAt(row_location, index, cell)
def set_row_tooltip(self, tool_tip, row):
+ if not tool_tip:
+ tool_tip = ''
+
row_location = self.row([row])
cell_data = self.data_processor_table.cellsAt(row_location)
for index, cell in enumerate(cell_data):
@@ -2144,14 +2146,18 @@ class SANSDataProcessorGui(QMainWindow,
row_locations = [self.row([x]) for x in row_locations]
self.data_processor_table.setSelectedRowLocations(row_locations)
- def add_row(self, value):
- value = [self.cell(x) for x in value]
+ def add_row(self, row_entries):
+ value = [self.cell(x) for x in self._convert_from_row_state(row_entries)]
self.data_processor_table.appendChildRowOf(self.row([]), value)
def remove_rows(self, rows):
rows = [self.row([item]) for item in rows]
self.data_processor_table.removeRows(rows)
+ def add_empty_row(self):
+ value = [self.cell('') for _ in self._column_index_map]
+ self.data_processor_table.appendChildRowOf(self.row([]), value)
+
def insert_empty_row(self, row_index):
self.data_processor_table.insertChildRowOf(self.row([]), row_index)
@@ -2166,24 +2172,86 @@ class SANSDataProcessorGui(QMainWindow,
def hide_period_columns(self):
self.multi_period_check_box.setChecked(False)
+
for col in self.MULTI_PERIOD_COLUMNS:
- self.data_processor_table.hideColumn(col)
+ self.data_processor_table.hideColumn(self._column_index_map[col])
def show_period_columns(self):
self.multi_period_check_box.setChecked(True)
for col in self.MULTI_PERIOD_COLUMNS:
- self.data_processor_table.showColumn(col)
+ self.data_processor_table.showColumn(self._column_index_map[col])
+
+ def _convert_from_row_state(self, row_state_obj):
+ assert isinstance(row_state_obj, RowEntries)
+ array = ['' for _ in self._column_index_map]
+ array[self._column_index_map["Can Direct"]] = row_state_obj.can_direct
+ array[self._column_index_map["Can Scatter"]] = row_state_obj.can_scatter
+ array[self._column_index_map["Can Transmission"]] = row_state_obj.can_transmission
+
+ array[self._column_index_map["Sample Direct"]] = row_state_obj.sample_direct
+ array[self._column_index_map["Sample Scatter"]] = row_state_obj.sample_scatter
+ array[self._column_index_map["Sample Transmission"]] = row_state_obj.sample_transmission
+
+ array[self._column_index_map["Options"]] = row_state_obj.options.get_displayed_text()
+ array[self._column_index_map["Output Name"]] = row_state_obj.output_name
+ array[self._column_index_map["User File"]] = row_state_obj.user_file
+
+ array[self._column_index_map["Sample Height"]] = row_state_obj.sample_height
+
+ sample_shape = row_state_obj.sample_shape.value if row_state_obj.sample_shape else ""
+ array[self._column_index_map["Sample Shape"]] = sample_shape
+ array[self._column_index_map["Sample Thickness"]] = row_state_obj.sample_thickness
+ array[self._column_index_map["Sample Width"]] = row_state_obj.sample_width
+
+ array[self._column_index_map["CDP"]] = row_state_obj.can_direct_period
+ array[self._column_index_map["CSP"]] = row_state_obj.can_scatter_period
+ array[self._column_index_map["CTP"]] = row_state_obj.can_transmission_period
+
+ array[self._column_index_map["SDP"]] = row_state_obj.sample_direct_period
+ array[self._column_index_map["SSP"]] = row_state_obj.sample_scatter_period
+ array[self._column_index_map["STP"]] = row_state_obj.sample_transmission_period
+ return array
+
+ def _convert_to_row_state(self, row_array):
+ entry = RowEntries()
+ entry.can_direct = row_array[self._column_index_map["Can Direct"]]
+ entry.can_scatter = row_array[self._column_index_map["Can Scatter"]]
+ entry.can_transmission = row_array[self._column_index_map["Can Transmission"]]
+
+ entry.sample_direct = row_array[self._column_index_map["Sample Direct"]]
+ entry.sample_scatter = row_array[self._column_index_map["Sample Scatter"]]
+ entry.sample_transmission = row_array[self._column_index_map["Sample Transmission"]]
+
+ entry.output_name = row_array[self._column_index_map["Output Name"]]
+ entry.user_file = row_array[self._column_index_map["User File"]]
+
+ entry.sample_height = row_array[self._column_index_map["Sample Height"]]
+ entry.sample_shape = row_array[self._column_index_map["Sample Shape"]]
+ entry.sample_thickness = row_array[self._column_index_map["Sample Thickness"]]
+ entry.sample_width = row_array[self._column_index_map["Sample Width"]]
+
+ entry.can_direct_period = row_array[self._column_index_map["CDP"]]
+ entry.can_scatter_period = row_array[self._column_index_map["CSP"]]
+ entry.can_transmission_period = row_array[self._column_index_map["CTP"]]
+
+ entry.sample_direct_period = row_array[self._column_index_map["SDP"]]
+ entry.sample_scatter_period = row_array[self._column_index_map["SSP"]]
+ entry.sample_transmission_period = row_array[self._column_index_map["STP"]]
+
+ entry.options.set_user_options(row_array[self._column_index_map["Options"]])
+
+ return entry
def show_geometry(self):
- self.data_processor_table.showColumn(15)
- self.data_processor_table.showColumn(16)
- self.data_processor_table.showColumn(17)
+ self.data_processor_table.showColumn(self._column_index_map["Sample Shape"])
+ self.data_processor_table.showColumn(self._column_index_map["Sample Height"])
+ self.data_processor_table.showColumn(self._column_index_map["Sample Width"])
def hide_geometry(self):
- self.data_processor_table.hideColumn(15)
- self.data_processor_table.hideColumn(16)
- self.data_processor_table.hideColumn(17)
+ self.data_processor_table.hideColumn(self._column_index_map["Sample Shape"])
+ self.data_processor_table.hideColumn(self._column_index_map["Sample Height"])
+ self.data_processor_table.hideColumn(self._column_index_map["Sample Width"])
def closeEvent(self, event):
for child in self.children():
diff --git a/scripts/Interface/ui/sans_isis/work_handler.py b/scripts/Interface/ui/sans_isis/work_handler.py
index 0918f2483f10715c0ead0703e2fe220d0651e227..0b0ffc884339bc6dfe405945a7fd29f02eeb76bb 100644
--- a/scripts/Interface/ui/sans_isis/work_handler.py
+++ b/scripts/Interface/ui/sans_isis/work_handler.py
@@ -58,7 +58,7 @@ class WorkHandler(object):
self.thread_pool = QThreadPool()
def _add_listener(self, listener, process_id, id):
- if not isinstance(listener, WorkHandler.WorkListener):
+ if not isinstance(listener, self.WorkListener):
raise ValueError("The listener is not of type "
"WorkListener but rather {}".format(type(listener)))
self._listener.update({process_id: {'id': id, 'listener': listener}})
diff --git a/scripts/MultiPlotting/subplot/subplot_context.py b/scripts/MultiPlotting/subplot/subplot_context.py
index 4304a3cfa1d146db46fef5d77545ad05ed12e2e6..0ce7f74f035d82ea6d0fab121a11dbf1c8b88994 100644
--- a/scripts/MultiPlotting/subplot/subplot_context.py
+++ b/scripts/MultiPlotting/subplot/subplot_context.py
@@ -53,10 +53,10 @@ class subplotContext(object):
plot_kwargs = {'specNum': spec_num, 'distribution': distribution, 'color': color}
# make plot/get label
- line, = plots.plotfunctions.plot(self._subplot, ws, **plot_kwargs)
+ line, = plots.axesfunctions.plot(self._subplot, ws, **plot_kwargs)
label = line.get_label()
if self._errors:
- line, cap_lines, bar_lines = plots.plotfunctions.errorbar(self._subplot, ws, **plot_kwargs)
+ line, cap_lines, bar_lines = plots.axesfunctions.errorbar(self._subplot, ws, **plot_kwargs)
all_lines = [line]
all_lines.extend(cap_lines)
all_lines.extend(bar_lines)
@@ -81,7 +81,7 @@ class subplotContext(object):
del self._lines[label]
# replot the line
if self._errors:
- line, cap_lines, bar_lines = plots.plotfunctions.errorbar(self._subplot,
+ line, cap_lines, bar_lines = plots.axesfunctions.errorbar(self._subplot,
self.get_ws(label),
specNum=self.specNum[label],
color=colour,
@@ -93,7 +93,7 @@ class subplotContext(object):
all_lines.extend(bar_lines)
self._lines[label] = all_lines
else:
- line, = plots.plotfunctions.plot(self._subplot,
+ line, = plots.axesfunctions.plot(self._subplot,
self.get_ws(label),
specNum=self.specNum[label],
color=colour,
diff --git a/scripts/Muon/GUI/Common/ADSHandler/muon_workspace_wrapper.py b/scripts/Muon/GUI/Common/ADSHandler/muon_workspace_wrapper.py
index f2e329054c8f9ab9603d21ef5cc0b045eedf29be..2eb74b56ddc5b77794c86756c9b6fc6653526f7e 100644
--- a/scripts/Muon/GUI/Common/ADSHandler/muon_workspace_wrapper.py
+++ b/scripts/Muon/GUI/Common/ADSHandler/muon_workspace_wrapper.py
@@ -41,7 +41,6 @@ class MuonWorkspaceWrapper(object):
self._workspace = None
self._directory_structure = ""
self._workspace_name = ""
-
if isinstance(workspace, Workspace):
self.workspace = workspace
else:
diff --git a/scripts/Muon/GUI/Common/calculate_pair_and_group.py b/scripts/Muon/GUI/Common/calculate_pair_and_group.py
index 441507e4c9694daa546eeafc659bbe870b866d31..32bf1f096480b166e8a8f18c805aab23099527b9 100644
--- a/scripts/Muon/GUI/Common/calculate_pair_and_group.py
+++ b/scripts/Muon/GUI/Common/calculate_pair_and_group.py
@@ -83,7 +83,6 @@ def _get_pre_processing_params(context, run, rebin):
pre_process_params["DeadTimeTable"] = dead_time_table
except KeyError:
pass
-
return pre_process_params
diff --git a/scripts/Muon/GUI/Common/contexts/muon_group_pair_context.py b/scripts/Muon/GUI/Common/contexts/muon_group_pair_context.py
index d9bc71cfa223c615a8170db02713989c0f88da25..fbba52a0e9f9cdd16dd3f67c8c7320eb8a269fa7 100644
--- a/scripts/Muon/GUI/Common/contexts/muon_group_pair_context.py
+++ b/scripts/Muon/GUI/Common/contexts/muon_group_pair_context.py
@@ -54,6 +54,7 @@ def get_default_grouping(workspace, instrument, main_field_direction):
grouping_file = workspace[0].getInstrument().getStringParameter(parameter_name)[0]
else:
grouping_file = workspace.getInstrument().getStringParameter(parameter_name)[0]
+
except IndexError:
return [], [], ''
else:
diff --git a/scripts/Muon/GUI/Common/plotting_widget/plotting_widget_view.py b/scripts/Muon/GUI/Common/plotting_widget/plotting_widget_view.py
index 4a042b3918fe30f4b06e7c2b1c160e2a3233a63b..b082396ecb29954f9e93c4818b1548d52e68287d 100644
--- a/scripts/Muon/GUI/Common/plotting_widget/plotting_widget_view.py
+++ b/scripts/Muon/GUI/Common/plotting_widget/plotting_widget_view.py
@@ -9,7 +9,7 @@ from __future__ import (absolute_import, division, print_function)
from qtpy import QtWidgets
import Muon.GUI.Common.message_box as message_box
from matplotlib.figure import Figure
-from mantidqt.plotting.functions import get_plot_fig
+from mantid.plots.plotfunctions import get_plot_fig
from matplotlib.backends.qt_compat import is_pyqt5
from MultiPlotting.QuickEdit.quickEdit_widget import QuickEditWidget
diff --git a/scripts/Muon/GUI/Common/utilities/load_utils.py b/scripts/Muon/GUI/Common/utilities/load_utils.py
index ac203c4a4cf9ab29c70096e6eab453fb9413d878..74894b9bac5a295ecd4109a891916a1d9d3d1422 100644
--- a/scripts/Muon/GUI/Common/utilities/load_utils.py
+++ b/scripts/Muon/GUI/Common/utilities/load_utils.py
@@ -211,33 +211,26 @@ def load_workspace_from_filename(filename,
load_result = _get_algorithm_properties(alg, output_properties)
load_result["OutputWorkspace"] = [MuonWorkspaceWrapper(ws) for ws in workspace.getNames()]
run = get_run_from_multi_period_data(workspace)
- if not psi_data:
- load_result["DataDeadTimeTable"] = AnalysisDataService.retrieve(load_result["DeadTimeTable"]).getNames()[0]
- for index, deadtime_table in enumerate(AnalysisDataService.retrieve(load_result["DeadTimeTable"]).getNames()):
- if index == 0:
- load_result["DataDeadTimeTable"] = deadtime_table
- else:
- DeleteWorkspace(Workspace=deadtime_table)
-
- load_result["FirstGoodData"] = round(load_result["FirstGoodData"] - load_result['TimeZero'], 2)
- UnGroupWorkspace(load_result["DeadTimeTable"])
- load_result["DeadTimeTable"] = None
- UnGroupWorkspace(workspace.name())
- else:
- load_result["DataDeadTimeTable"] = None
- load_result["FirstGoodData"] = round(load_result["FirstGoodData"], 2)
+
+ deadtime_tables = AnalysisDataService.retrieve(load_result["DeadTimeTable"]).getNames()
+ load_result["DataDeadTimeTable"] = deadtime_tables[0]
+ for table in deadtime_tables[1:]:
+ DeleteWorkspace(Workspace=table)
+
+ load_result["FirstGoodData"] = round(load_result["FirstGoodData"] - load_result['TimeZero'], 2)
+ UnGroupWorkspace(load_result["DeadTimeTable"])
+ load_result["DeadTimeTable"] = None
+ UnGroupWorkspace(workspace.name())
+
else:
# single period data
load_result = _get_algorithm_properties(alg, output_properties)
load_result["OutputWorkspace"] = [MuonWorkspaceWrapper(load_result["OutputWorkspace"])]
run = int(workspace.getRunNumber())
- if not psi_data:
- load_result["DataDeadTimeTable"] = load_result["DeadTimeTable"]
- load_result["DeadTimeTable"] = None
- load_result["FirstGoodData"] = round(load_result["FirstGoodData"] - load_result['TimeZero'], 2)
- else:
- load_result["DataDeadTimeTable"] = None
- load_result["FirstGoodData"] = round(load_result["FirstGoodData"], 2)
+
+ load_result["DataDeadTimeTable"] = load_result["DeadTimeTable"]
+ load_result["DeadTimeTable"] = None
+ load_result["FirstGoodData"] = round(load_result["FirstGoodData"] - load_result['TimeZero'], 2)
return load_result, run, filename, psi_data
@@ -256,7 +249,7 @@ def create_load_algorithm(filename, property_dictionary):
else:
alg = mantid.AlgorithmManager.create("LoadMuonNexus")
alg.setProperties(property_dictionary)
- alg.setProperty("DeadTimeTable", output_filename + '_deadtime_table')
+ alg.setProperty("DeadTimeTable", output_filename + '_deadtime_table')
alg.initialize()
alg.setAlwaysStoreInADS(True)
diff --git a/scripts/SANS/ISISCommandInterface.py b/scripts/SANS/ISISCommandInterface.py
index cb7ed5aa519abf6f8f1a91f10a295f327165759f..da0d2e6e5749ea4139b1c7a9cef9b5531ae1d576 100644
--- a/scripts/SANS/ISISCommandInterface.py
+++ b/scripts/SANS/ISISCommandInterface.py
@@ -16,7 +16,6 @@ from mantid.kernel import Logger
import isis_reduction_steps
import isis_reducer
from centre_finder import *
-# import SANSReduction
from mantid.simpleapi import *
from mantid.api import WorkspaceGroup, ExperimentInfo
import copy
@@ -24,6 +23,15 @@ from SANSadd2 import *
import SANSUtility as su
from SANSUtility import deprecated
import SANSUserFileParser as UserFileParser
+
+import warnings
+warnings.simplefilter("default", category=DeprecationWarning)
+warnings.warn("This ISIS Command Interface is deprecated.\n"
+ "Please change 'import ISISCommandInterface' or 'from ISISCommandInterface'"
+ "to use 'sans.command_interface.ISISCommandInterface' instead.", DeprecationWarning,
+ stacklevel=2)
+warnings.simplefilter("ignore", category=DeprecationWarning)
+
sanslog = Logger("SANS")
# disable plotting if running outside Mantidplot
@@ -235,6 +243,22 @@ def SetMergeQRange(q_min=None, q_max=None):
_printMessage('#Set merge range values')
+def SetDetectorMaskFiles(filenames):
+ assert isinstance(filenames, str),\
+ "Expected a command seperated list of filenames, got %r instead" % filenames
+ ReductionSingleton().settings["MaskFiles"] = filenames
+ _printMessage('#Set masking file names to {0}'.format(filenames))
+
+
+def SetMonDirect(correction_file):
+ if not ReductionSingleton().instrument:
+ raise RuntimeError("You must create an instrument object first")
+
+ ReductionSingleton().instrument.cur_detector().correction_file = correction_file
+ ReductionSingleton().instrument.other_detector().correction_file = correction_file
+ _printMessage('#Set MonDirect to {0}'.format(correction_file))
+
+
def TransFit(mode, lambdamin=None, lambdamax=None, selector='BOTH'):
"""
Sets the fit method to calculate the transmission fit and the wavelength range
diff --git a/scripts/SANS/sans/algorithm_detail/batch_execution.py b/scripts/SANS/sans/algorithm_detail/batch_execution.py
index a7f3932de0bff005450855bb9981e3f540c06b65..27ee50afb02c5dbca50b5908964fab810a840c2c 100644
--- a/scripts/SANS/sans/algorithm_detail/batch_execution.py
+++ b/scripts/SANS/sans/algorithm_detail/batch_execution.py
@@ -9,7 +9,7 @@ from __future__ import (absolute_import, division, print_function)
from copy import deepcopy
from mantid.api import AnalysisDataService, WorkspaceGroup
-from sans.common.general_functions import (add_to_sample_log, create_managed_non_child_algorithm,
+from sans.common.general_functions import (create_managed_non_child_algorithm,
create_unmanaged_algorithm, get_output_name,
get_base_name_from_multi_period_name, get_transmission_output_name)
from sans.common.enums import (SANSDataType, SaveType, OutputMode, ReductionMode, DataType)
@@ -23,7 +23,7 @@ from sans.common.constants import (TRANS_SUFFIX, SANS_SUFFIX, ALL_PERIODS,
from sans.common.file_information import (get_extension_for_file_type, SANSFileInformationFactory)
from sans.gui_logic.plotting import get_plotting_module
from sans.state.Serializer import Serializer
-from sans.state.data import StateData
+from sans.state.StateObjects.StateData import StateData
# ----------------------------------------------------------------------------------------------------------------------
@@ -127,12 +127,9 @@ def single_reduction_for_batch(state, use_optimizations, output_mode, plot_resul
# -----------------------------------
# Get the output of the algorithm
# -----------------------------------
- reduction_package.reduced_lab = get_workspace_from_algorithm(reduction_alg, "OutputWorkspaceLAB",
- add_logs=True, user_file=state.data.user_file)
- reduction_package.reduced_hab = get_workspace_from_algorithm(reduction_alg, "OutputWorkspaceHAB",
- add_logs=True, user_file=state.data.user_file)
- reduction_package.reduced_merged = get_workspace_from_algorithm(reduction_alg, "OutputWorkspaceMerged",
- add_logs=True, user_file=state.data.user_file)
+ reduction_package.reduced_lab = get_workspace_from_algorithm(reduction_alg, "OutputWorkspaceLAB")
+ reduction_package.reduced_hab = get_workspace_from_algorithm(reduction_alg, "OutputWorkspaceHAB")
+ reduction_package.reduced_merged = get_workspace_from_algorithm(reduction_alg, "OutputWorkspaceMerged")
reduction_package.reduced_lab_can = get_workspace_from_algorithm(reduction_alg, "OutputWorkspaceLABCan")
reduction_package.reduced_lab_can_count = get_workspace_from_algorithm(reduction_alg,
@@ -959,15 +956,13 @@ def set_properties_for_reduction_algorithm(reduction_alg, reduction_package, wor
, "unfitted_transmission_can_name", "unfitted_transmission_can_base_name")
-def get_workspace_from_algorithm(alg, output_property_name, add_logs=False, user_file=""):
+def get_workspace_from_algorithm(alg, output_property_name):
"""
Gets the output workspace from an algorithm. Since we don't run this as a child we need to get it from the
ADS.
:param alg: a handle to the algorithm from which we want to take the output workspace property.
:param output_property_name: the name of the output property.
- :param add_logs: optional bool. If true, then add logs to the retrieved workspace
- :param user_file: optional string. If add_logs, add user_file to the property "User File"
:return the workspace or None
"""
output_workspace_name = alg.getProperty(output_property_name).valueAsStr
@@ -977,8 +972,6 @@ def get_workspace_from_algorithm(alg, output_property_name, add_logs=False, user
if AnalysisDataService.doesExist(output_workspace_name):
ws = AnalysisDataService.retrieve(output_workspace_name)
- if add_logs:
- add_to_sample_log(ws, "UserFile", user_file, "String")
return ws
else:
return None
diff --git a/scripts/SANS/sans/algorithm_detail/load_data.py b/scripts/SANS/sans/algorithm_detail/load_data.py
index 205473d3d943bf4e87d1e0db5018822fcf090409..fcd843028a78ddf1903607b69367ac2cccdda466 100644
--- a/scripts/SANS/sans/algorithm_detail/load_data.py
+++ b/scripts/SANS/sans/algorithm_detail/load_data.py
@@ -62,7 +62,7 @@ from sans.common.constants import (EMPTY_NAME, SANS_SUFFIX, TRANS_SUFFIX, MONITO
from sans.common.enums import (SANSFacility, SANSDataType, SANSInstrument)
from sans.common.general_functions import (create_child_algorithm)
from sans.common.log_tagger import (set_tag, has_tag, get_tag)
-from sans.state.data import (StateData)
+from sans.state.StateObjects.StateData import (StateData)
from sans.algorithm_detail.calibration import apply_calibration
diff --git a/scripts/SANS/sans/algorithm_detail/move_workspaces.py b/scripts/SANS/sans/algorithm_detail/move_workspaces.py
index f8ee3bc0cb21b98ad293f011bbfb319fcc580468..46786647fac02bbf4c2aa27e0d759a51bf929d85 100644
--- a/scripts/SANS/sans/algorithm_detail/move_workspaces.py
+++ b/scripts/SANS/sans/algorithm_detail/move_workspaces.py
@@ -11,7 +11,7 @@ import math
from mantid.api import MatrixWorkspace
from six import with_metaclass
from abc import (ABCMeta, abstractmethod)
-from sans.state.move import StateMove
+from sans.state.StateObjects.StateMoveDetectors import StateMove
from sans.common.enums import CanonicalCoordinates, DetectorType, SANSInstrument
from sans.common.general_functions import (create_unmanaged_algorithm, get_single_valued_logs_from_workspace,
quaternion_to_angle_and_axis, sanitise_instrument_name)
@@ -103,11 +103,6 @@ def move_backstop_monitor(ws, move_info, monitor_offset, monitor_spectrum_number
:param monitor_offset: Offset to shift by (m)
:param monitor_spectrum_number: The spectrum number of the monitor to shift
"""
- # Back out early so we don't shift the monitor from the IDF position to the
- # rear detector position by accident
- if monitor_offset == 0.0:
- return
-
monitor_spectrum_number_as_string = str(monitor_spectrum_number)
# TODO we should pass the detector ID through, not the spec num
monitor_n_name = move_info.monitor_names[monitor_spectrum_number_as_string]
@@ -500,6 +495,7 @@ class SANSMoveSANS2D(SANSMove):
hab_detector.side_correction*(1.0 - math.cos(rotation_in_radians)) +
(hab_detector_radius + hab_detector.radius_correction)*(math.sin(rotation_in_radians))) -
hab_detector_default_x_m - x)
+
y_shift = hab_detector.y_translation_correction - y
z_shift = (hab_detector_z + hab_detector.z_translation_correction +
(hab_detector_radius + hab_detector.radius_correction) * (1.0 - math.cos(rotation_in_radians)) -
diff --git a/scripts/SANS/sans/command_interface/ISISCommandInterface.py b/scripts/SANS/sans/command_interface/ISISCommandInterface.py
index a5a41163238b5d8dfa9462cf7baeac644e867c34..2052954713e5bdc64922623429b9c8671078f4b8 100644
--- a/scripts/SANS/sans/command_interface/ISISCommandInterface.py
+++ b/scripts/SANS/sans/command_interface/ISISCommandInterface.py
@@ -5,24 +5,36 @@
# & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
from __future__ import (absolute_import, division, print_function)
-import re
+
import inspect
+import os
+import re
+
+import six
from six import types
-from mantid.kernel import config
-from mantid.api import (AnalysisDataService, WorkspaceGroup)
+
from SANSadd2 import add_runs
-from sans.sans_batch import SANSBatchReduction, SANSCentreFinder
+from mantid.api import (AnalysisDataService, WorkspaceGroup)
+from mantid.kernel import config
+from sans.command_interface.batch_csv_parser import BatchCsvParser
from sans.command_interface.command_interface_functions import (print_message, warning_message)
from sans.command_interface.command_interface_state_director import (CommandInterfaceStateDirector, DataCommand,
- DataCommandId, NParameterCommand, NParameterCommandId,
+ DataCommandId, NParameterCommand,
+ NParameterCommandId,
FitData)
-from sans.command_interface.batch_csv_file_parser import BatchCsvParser
from sans.common.constants import ALL_PERIODS
-from sans.common.file_information import (find_sans_file, find_full_file_path)
from sans.common.enums import (DetectorType, FitType, RangeStepType, ReductionDimensionality,
- ReductionMode, SANSFacility, SaveType, BatchReductionEntry, OutputMode, FindDirectionEnum)
+ ReductionMode, SANSFacility, SaveType, OutputMode, FindDirectionEnum)
+from sans.common.file_information import (find_sans_file, find_full_file_path)
from sans.common.general_functions import (convert_bank_name_to_detector_type_isis, get_output_name,
is_part_of_reduced_output_workspace_group)
+from sans.gui_logic.models.RowEntries import RowEntries
+from sans.sans_batch import SANSBatchReduction, SANSCentreFinder
+
+if six.PY2:
+ # This can be swapped with in box FileNotFoundError
+ FileNotFoundError = IOError
+
# Disable plotting if running outside Mantidplot
try:
@@ -319,11 +331,16 @@ def MaskFile(file_name):
@param file_name: path to the user file.
"""
- print_message('#Opening "' + file_name + '"')
+ if not file_name:
+ raise ValueError("An empty filename was passed to MaskFile")
+
+ file_path = file_name if os.path.exists(file_name) else find_full_file_path(file_name)
- # Get the full file path
- file_name_full = find_full_file_path(file_name)
- user_file_command = NParameterCommand(command_id=NParameterCommandId.USER_FILE, values=[file_name_full])
+ if not file_path or not os.path.isfile(file_path):
+ raise FileNotFoundError("Could not find MaskFile: {0}".format(file_name))
+
+ print_message('#Opening "' + file_path + '"')
+ user_file_command = NParameterCommand(command_id=NParameterCommandId.USER_FILE, values=[file_path])
director.add_command(user_file_command)
@@ -858,50 +875,51 @@ def BatchReduce(filename, format, plotresults=False, saveAlgs=None, verbose=Fals
output_mode = OutputMode.PUBLISH_TO_ADS
# Get the information from the csv file
- batch_csv_parser = BatchCsvParser(filename)
- parsed_batch_entries = batch_csv_parser.parse_batch_file()
+ batch_csv_parser = BatchCsvParser()
+ parsed_batch_entries = batch_csv_parser.parse_batch_file(filename)
# Get a state with all existing settings
for parsed_batch_entry in parsed_batch_entries:
+ assert isinstance(parsed_batch_entry, RowEntries)
# A new user file. If a new user file is provided then this will overwrite all other settings from,
# otherwise we might have cross-talk between user files.
- if BatchReductionEntry.USER_FILE in list(parsed_batch_entry.keys()):
- user_file = parsed_batch_entry[BatchReductionEntry.USER_FILE]
- MaskFile(user_file)
+ if parsed_batch_entry.user_file:
+ MaskFile(parsed_batch_entry.user_file)
# Sample scatter
- sample_scatter = parsed_batch_entry[BatchReductionEntry.SAMPLE_SCATTER]
- sample_scatter_period = parsed_batch_entry[BatchReductionEntry.SAMPLE_SCATTER_PERIOD]
+ sample_scatter = parsed_batch_entry.sample_scatter
+ sample_scatter_period = parsed_batch_entry.sample_scatter_period
AssignSample(sample_run=sample_scatter, period=sample_scatter_period)
# Sample transmission
- if (BatchReductionEntry.SAMPLE_TRANSMISSION in list(parsed_batch_entry.keys()) and
- BatchReductionEntry.SAMPLE_DIRECT in list(parsed_batch_entry.keys())):
- sample_transmission = parsed_batch_entry[BatchReductionEntry.SAMPLE_TRANSMISSION]
- sample_transmission_period = parsed_batch_entry[BatchReductionEntry.SAMPLE_TRANSMISSION_PERIOD]
- sample_direct = parsed_batch_entry[BatchReductionEntry.SAMPLE_DIRECT]
- sample_direct_period = parsed_batch_entry[BatchReductionEntry.SAMPLE_DIRECT_PERIOD]
+ if parsed_batch_entry.sample_transmission and parsed_batch_entry.sample_direct:
+ sample_direct = parsed_batch_entry.sample_direct
+ sample_direct_period = parsed_batch_entry.sample_direct_period
+
+ sample_transmission = parsed_batch_entry.sample_transmission
+ sample_transmission_period = parsed_batch_entry.sample_transmission_period
+
TransmissionSample(sample=sample_transmission, direct=sample_direct,
period_t=sample_transmission_period, period_d=sample_direct_period)
# Can scatter
- if BatchReductionEntry.CAN_SCATTER in list(parsed_batch_entry.keys()):
- can_scatter = parsed_batch_entry[BatchReductionEntry.CAN_SCATTER]
- can_scatter_period = parsed_batch_entry[BatchReductionEntry.CAN_SCATTER_PERIOD]
+ if parsed_batch_entry.can_scatter:
+ can_scatter = parsed_batch_entry.can_scatter
+ can_scatter_period = parsed_batch_entry.can_scatter_period
AssignCan(can_run=can_scatter, period=can_scatter_period)
# Can transmission
- if (BatchReductionEntry.CAN_TRANSMISSION in list(parsed_batch_entry.keys()) and
- BatchReductionEntry.CAN_DIRECT in list(parsed_batch_entry.keys())):
- can_transmission = parsed_batch_entry[BatchReductionEntry.CAN_TRANSMISSION]
- can_transmission_period = parsed_batch_entry[BatchReductionEntry.CAN_TRANSMISSION_PERIOD]
- can_direct = parsed_batch_entry[BatchReductionEntry.CAN_DIRECT]
- can_direct_period = parsed_batch_entry[BatchReductionEntry.CAN_DIRECT_PERIOD]
+ if parsed_batch_entry.can_transmission and parsed_batch_entry.can_direct:
+ can_transmission = parsed_batch_entry.can_transmission
+ can_transmission_period = parsed_batch_entry.can_transmission_period
+ can_direct = parsed_batch_entry.can_direct
+ can_direct_period = parsed_batch_entry.can_direct_period
+
TransmissionCan(can=can_transmission, direct=can_direct,
period_t=can_transmission_period, period_d=can_direct_period)
# Name of the output. We need to modify the name according to the setup of the old reduction mechanism
- output_name = parsed_batch_entry[BatchReductionEntry.OUTPUT]
+ output_name = parsed_batch_entry.output_name
# In addition to the output name the user can specify with combineDet an additional suffix (in addition to the
# suffix that the user can set already -- was there previously, so we have to provide that)
@@ -922,19 +940,18 @@ def BatchReduce(filename, format, plotresults=False, saveAlgs=None, verbose=Fals
# 3. The last scatter transmission and direct entry (if any were set)
# 4. The last can scatter ( if any was set)
# 5. The last can transmission and direct entry (if any were set)
- if BatchReductionEntry.USER_FILE in list(parsed_batch_entry.keys()):
+ if parsed_batch_entry.user_file:
director.remove_last_user_file()
+
director.remove_last_scatter_sample()
- if (BatchReductionEntry.SAMPLE_TRANSMISSION in list(parsed_batch_entry.keys()) and
- BatchReductionEntry.SAMPLE_DIRECT in list(parsed_batch_entry.keys())): # noqa
+ if parsed_batch_entry.sample_transmission and parsed_batch_entry.sample_direct:
director.remove_last_sample_transmission_and_direct()
- if BatchReductionEntry.CAN_SCATTER in list(parsed_batch_entry.keys()):
+ if parsed_batch_entry.can_scatter:
director.remove_last_scatter_can()
- if (BatchReductionEntry.CAN_TRANSMISSION in list(parsed_batch_entry.keys()) and
- BatchReductionEntry.CAN_DIRECT in list(parsed_batch_entry.keys())):
+ if parsed_batch_entry.can_transmission and parsed_batch_entry.can_direct:
director.remove_last_can_transmission_and_direct()
# Plot the results if that was requested, the flag 1 is from the old version.
diff --git a/scripts/SANS/sans/command_interface/batch_csv_file_parser.py b/scripts/SANS/sans/command_interface/batch_csv_file_parser.py
deleted file mode 100644
index 78d3c5a4226d30944eedfcb9440ae1ff3f46c479..0000000000000000000000000000000000000000
--- a/scripts/SANS/sans/command_interface/batch_csv_file_parser.py
+++ /dev/null
@@ -1,168 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-from __future__ import (absolute_import, division, print_function)
-import re
-from csv import reader
-from sans.common.enums import BatchReductionEntry
-from sans.common.file_information import find_full_file_path
-from sans.common.constants import ALL_PERIODS
-
-
-class BatchCsvParser(object):
- batch_file_keywords = {"sample_sans": BatchReductionEntry.SAMPLE_SCATTER,
- "output_as": BatchReductionEntry.OUTPUT,
- "sample_trans": BatchReductionEntry.SAMPLE_TRANSMISSION,
- "sample_direct_beam": BatchReductionEntry.SAMPLE_DIRECT,
- "can_sans": BatchReductionEntry.CAN_SCATTER,
- "can_trans": BatchReductionEntry.CAN_TRANSMISSION,
- "can_direct_beam": BatchReductionEntry.CAN_DIRECT,
- "user_file": BatchReductionEntry.USER_FILE,
- "sample_thickness": BatchReductionEntry.SAMPLE_THICKNESS,
- "sample_height": BatchReductionEntry.SAMPLE_HEIGHT,
- "sample_width": BatchReductionEntry.SAMPLE_WIDTH}
- batch_file_keywords_which_are_dropped = {"background_sans": None,
- "background_trans": None,
- "background_direct_beam": None,
- "": None}
-
- data_keys = {BatchReductionEntry.SAMPLE_SCATTER: BatchReductionEntry.SAMPLE_SCATTER_PERIOD,
- BatchReductionEntry.SAMPLE_TRANSMISSION: BatchReductionEntry.SAMPLE_TRANSMISSION_PERIOD,
- BatchReductionEntry.SAMPLE_DIRECT: BatchReductionEntry.SAMPLE_DIRECT_PERIOD,
- BatchReductionEntry.CAN_SCATTER: BatchReductionEntry.CAN_SCATTER_PERIOD,
- BatchReductionEntry.CAN_TRANSMISSION: BatchReductionEntry.CAN_TRANSMISSION_PERIOD,
- BatchReductionEntry.CAN_DIRECT: BatchReductionEntry.CAN_DIRECT_PERIOD}
-
- def __init__(self, batch_file_name):
- super(BatchCsvParser, self).__init__()
- # Get the full file path
- self._batch_file_name = find_full_file_path(batch_file_name)
- if not self._batch_file_name:
- raise RuntimeError("batch_csv_file_parser: Could not find specified batch file. Make sure it is available"
- "in the Mantid path settings.")
-
- def parse_batch_file(self):
- """
- Parses the batch csv file and returns the elements in a parsed form
-
- Returns: parsed csv elements
- """
-
- parsed_rows = []
-
- with open(self._batch_file_name, 'r') as csvfile:
- batch_reader = reader(csvfile, delimiter=",")
- row_number = 0
- for row in batch_reader:
- # Check if the row is empty
- if not row:
- continue
-
- # If the first element contains a # symbol then ignore it
- if "MANTID_BATCH_FILE" in row[0]:
- continue
-
- # Else we perform a parse of the row
- parsed_row = self._parse_row(row, row_number)
- parsed_rows.append(parsed_row)
- row_number += 1
- return parsed_rows
-
- def _parse_row(self, row, row_number):
- # Clean all elements of the row
- row = list(map(str.strip, row))
-
- # If the reader has ignored the final empty row, we add it back here
- if len(row) % 2 == 1 and row[-1] in self.batch_file_keywords:
- row.append("")
-
- # Go sequentially through the row with a stride of two. The user can either leave entries away, or he can leave
- # them blank, ie ... , sample_direct_beam, , can_sans, XXXXX, ... or even ..., , ,...
- # This means we expect an even length of entries
- if len(row) % 2 != 0:
- raise RuntimeError("We expect an even number of entries, but row {0} has {1} entries.".format(row_number,
- len(row)))
- output = {}
- # Special attention has to go to the specification of the period in a run number. The user can
- # specify something like 5512p for sample scatter. This means she wants run number 5512 with period 7.
- for key, value in zip(row[::2], row[1::2]):
- if key in list(BatchCsvParser.batch_file_keywords.keys()):
- new_key = BatchCsvParser.batch_file_keywords[key]
- value = value.strip()
- if BatchCsvParser._is_data_entry(new_key):
- run_number, period, period_key = BatchCsvParser._get_run_number_and_period(new_key, value)
- output.update({new_key: run_number})
- output.update({period_key: period})
- else:
- output.update({new_key: value})
- elif key in list(self.batch_file_keywords_which_are_dropped.keys()):
- continue
- else:
- raise RuntimeError("The key {0} is not part of the SANS batch csv file keywords".format(key))
-
- # Ensure that sample_scatter was set
- if BatchReductionEntry.SAMPLE_SCATTER not in output or not output[BatchReductionEntry.SAMPLE_SCATTER]:
- raise RuntimeError("The sample_scatter entry in row {0} seems to be missing.".format(row_number))
-
- # Ensure that the transmission data for the sample is specified either completely or not at all.
- has_sample_transmission = BatchReductionEntry.SAMPLE_TRANSMISSION in output and \
- output[BatchReductionEntry.SAMPLE_TRANSMISSION] # noqa
- has_sample_direct_beam = BatchReductionEntry.SAMPLE_DIRECT in output and output[BatchReductionEntry.SAMPLE_DIRECT]
-
- if (not has_sample_transmission and has_sample_direct_beam) or \
- (has_sample_transmission and not has_sample_direct_beam):
- raise RuntimeError("Inconsistent sample transmission settings in row {0}. Either both the transmission "
- "and the direct beam run are set or none.".format(row_number))
-
- # Ensure that the transmission data for the can is specified either completely or not at all.
- has_can_transmission = BatchReductionEntry.CAN_TRANSMISSION in output and \
- output[BatchReductionEntry.CAN_TRANSMISSION] # noqa
- has_can_direct_beam = BatchReductionEntry.CAN_DIRECT in output and output[BatchReductionEntry.CAN_DIRECT]
-
- if (not has_can_transmission and has_can_direct_beam) or \
- (has_can_transmission and not has_can_direct_beam):
- raise RuntimeError("Inconsistent can transmission settings in row {0}. Either both the transmission "
- "and the direct beam run are set or none.".format(row_number))
-
- # Ensure that can scatter is specified if the transmissions are set
- has_can_scatter = BatchReductionEntry.CAN_SCATTER in output and output[BatchReductionEntry.CAN_SCATTER]
- if not has_can_scatter and has_can_transmission:
- raise RuntimeError("The can transmission was set but not the scatter file in row {0}.".format(row_number))
- return output
-
- @staticmethod
- def _is_data_entry(entry):
- data_entry_keys = list(BatchCsvParser.data_keys.keys())
- for data_enum in data_entry_keys:
- if entry is data_enum:
- return True
- return False
-
- @staticmethod
- def _get_run_number_and_period(data_type, entry):
- """
- Gets the run number and the period from a csv data entry.
-
- @patam data_type: the type of data entry, e.g. BatchReductionEntry.SampleScatter
- @param entry: a data entry, e.g. 5512 or 5512p7
- @return: the run number, the period selection and the corresponding key word
- """
- data_period_type = BatchCsvParser.data_keys[data_type]
-
- # Slice off period if it exists. If it does not exist, then the period is ALL_PERIODS
- period_pattern = "[p,P][0-9]$"
-
- has_period = re.search(period_pattern, entry)
-
- period = ALL_PERIODS
- run_number = entry
- if has_period:
- run_number = re.sub(period_pattern, "", entry)
- period_partial = re.sub(run_number, "", entry)
- period = re.sub("[p,P]", "", period_partial)
- period = int(period)
-
- return run_number, period, data_period_type
diff --git a/scripts/SANS/sans/command_interface/batch_csv_parser.py b/scripts/SANS/sans/command_interface/batch_csv_parser.py
new file mode 100644
index 0000000000000000000000000000000000000000..621f519609bf01b83df77b586bb4d4ec55cef2fc
--- /dev/null
+++ b/scripts/SANS/sans/command_interface/batch_csv_parser.py
@@ -0,0 +1,225 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+from __future__ import (absolute_import, division, print_function)
+
+import csv
+import re
+from csv import reader
+from enum import Enum
+
+from mantid.py3compat import csv_open_type
+from sans.common.constants import ALL_PERIODS
+from sans.common.file_information import find_full_file_path
+from sans.gui_logic.models.RowEntries import RowEntries
+
+
+class BatchFileKeywords(Enum):
+ SAMPLE_SCATTER = "sample_sans"
+ OUTPUT = "output_as"
+ SAMPLE_TRANSMISSION = "sample_trans"
+ SAMPLE_DIRECT = "sample_direct_beam"
+ CAN_SCATTER = "can_sans"
+ CAN_TRANSMISSION = "can_trans"
+ CAN_DIRECT = "can_direct_beam"
+ USER_FILE = "user_file"
+ SAMPLE_THICKNESS = "sample_thickness"
+ SAMPLE_HEIGHT = "sample_height"
+ SAMPLE_WIDTH = "sample_width"
+
+
+class BatchCsvParser(object):
+ IGNORED_KEYWORDS = {"background_sans", "background_trans", "background_direct_beam", ""}
+ COMMENT_KEWORDS = {'#', "MANTID_BATCH_FILE"}
+
+ def parse_batch_file(self, batch_file_name):
+ """
+ Parses the batch csv file and returns the elements in a parsed form
+
+ Returns: parsed csv elements
+ """
+ # Get the full file path
+ batch_file_name = find_full_file_path(batch_file_name)
+ if not batch_file_name:
+ raise RuntimeError("batch_csv_file_parser: Could not find specified batch file. Make sure it is available"
+ "in the Mantid path settings.")
+
+ parsed_rows = []
+
+ with open(batch_file_name, 'r') as csvfile:
+ batch_reader = reader(csvfile, delimiter=",")
+ read_rows = list(batch_reader)
+
+ for row_number, row in enumerate(read_rows):
+ # Check if the row is empty or is a comment
+ if not row:
+ continue
+
+ key = row[0].strip()
+ if any(key.startswith(i) for i in self.COMMENT_KEWORDS):
+ continue
+
+ # Else we perform a parse of the row
+ parsed_row = self._parse_csv_row(row, row_number)
+ parsed_rows.append(parsed_row)
+ return parsed_rows
+
+ def save_batch_file(self, rows, file_path):
+ to_write = []
+ for row in rows:
+ to_write.append(self._convert_row_to_list(row))
+
+ with open(file_path, csv_open_type) as outfile:
+ writer_handle = csv.writer(outfile)
+ for line in to_write:
+ writer_handle.writerow(line)
+
+ @staticmethod
+ def _convert_row_to_list(row):
+ assert isinstance(row, RowEntries)
+
+ def pack_val(obj_val):
+ return str(obj_val) if obj_val else ''
+
+ def pack_period(run_val, period_val):
+ # Appends the period if it's present, otherwise leaves string untouched
+ csv_val = pack_val(run_val)
+ return csv_val + 'P' + str(period_val) if period_val else csv_val
+
+ # Non-optional (i.e. expected) fields
+ # Try to keep the order found in the GUI back outwards
+ return [BatchFileKeywords.SAMPLE_SCATTER.value, pack_period(row.sample_scatter, row.sample_scatter_period),
+
+ BatchFileKeywords.SAMPLE_TRANSMISSION.value, pack_period(row.sample_transmission,
+ row.sample_transmission_period),
+ BatchFileKeywords.SAMPLE_DIRECT.value, pack_period(row.sample_direct, row.sample_direct_period),
+
+ BatchFileKeywords.CAN_SCATTER.value, pack_period(row.can_scatter, row.can_scatter_period),
+
+ BatchFileKeywords.CAN_TRANSMISSION.value, pack_period(row.can_transmission,
+ row.can_transmission_period),
+ BatchFileKeywords.CAN_DIRECT.value, pack_period(row.can_direct, row.can_direct_period),
+
+ BatchFileKeywords.OUTPUT.value, pack_val(row.output_name),
+ BatchFileKeywords.USER_FILE.value, pack_val(row.user_file),
+ BatchFileKeywords.SAMPLE_THICKNESS.value, pack_val(row.sample_thickness),
+
+ # Optional but pack them anyway for completeness
+ BatchFileKeywords.SAMPLE_HEIGHT.value, pack_val(row.sample_height),
+ BatchFileKeywords.SAMPLE_WIDTH.value, pack_val(row.sample_width)
+ ]
+
+ def _parse_csv_row(self, row, row_number):
+ # Clean all elements of the row
+ row = list(map(str.strip, row))
+ output = RowEntries()
+ # Special attention has to go to the specification of the period in a run number. The user can
+ # specify something like 5512p for sample scatter. This means they want run number 5512 with period 7.
+ for key, value in zip(row[::2], row[1::2]):
+ if key in self.IGNORED_KEYWORDS:
+ continue
+
+ try:
+ key_enum = BatchFileKeywords(key)
+ except ValueError:
+ raise KeyError("The key {0} is not part of the SANS batch csv file keywords".format(key))
+
+ try:
+ BatchFileKeywords(value)
+ raise KeyError("The value {0} is a keyword, you may have missed a comma after {1}".format(value, key))
+ except ValueError:
+ pass # User did not accidentally use a key as a value
+
+ self._parse_row_entry(key_enum, value, row_entry=output)
+
+ self.validate_output(output, row_number)
+
+ return output
+
+ def _parse_row_entry(self, key_enum, value, row_entry):
+ value = value.strip()
+ if key_enum is BatchFileKeywords.CAN_DIRECT:
+ run_number, period = self._get_run_number_and_period(value)
+ row_entry.can_direct = run_number
+ row_entry.can_direct_period = period
+
+ elif key_enum is BatchFileKeywords.CAN_SCATTER:
+ run_number, period = self._get_run_number_and_period(value)
+ row_entry.can_scatter = run_number
+ row_entry.can_scatter_period = period
+
+ elif key_enum is BatchFileKeywords.CAN_TRANSMISSION:
+ run_number, period = self._get_run_number_and_period(value)
+ row_entry.can_transmission = run_number
+ row_entry.can_transmission_period = period
+
+ elif key_enum is BatchFileKeywords.SAMPLE_DIRECT:
+ run_number, period = self._get_run_number_and_period(value)
+ row_entry.sample_direct = run_number
+ row_entry.sample_direct_period = period
+
+ elif key_enum is BatchFileKeywords.SAMPLE_SCATTER:
+ run_number, period = self._get_run_number_and_period(value)
+ row_entry.sample_scatter = run_number
+ row_entry.sample_scatter_period = period
+
+ elif key_enum is BatchFileKeywords.SAMPLE_TRANSMISSION:
+ run_number, period = self._get_run_number_and_period(value)
+ row_entry.sample_transmission = run_number
+ row_entry.sample_transmission_period = period
+
+ elif key_enum is BatchFileKeywords.SAMPLE_HEIGHT:
+ row_entry.sample_height = value
+ elif key_enum is BatchFileKeywords.SAMPLE_THICKNESS:
+ row_entry.sample_thickness = value
+ elif key_enum is BatchFileKeywords.SAMPLE_WIDTH:
+ row_entry.sample_width = value
+
+ elif key_enum is BatchFileKeywords.OUTPUT:
+ row_entry.output_name = value
+ elif key_enum is BatchFileKeywords.USER_FILE:
+ row_entry.user_file = value
+
+ else:
+ raise RuntimeError("Batch Enum key {0} has not been handled".format(key_enum))
+
+ @staticmethod
+ def _get_run_number_and_period(entry):
+ """
+ Gets the run number and the period from a csv data entry.
+ @param entry: a data entry, e.g. 5512 or 5512p7
+ @return: the run number, the period selection and the corresponding key word
+ """
+ # Slice off period if it exists. If it does not exist, then the period is ALL_PERIODS
+ period_pattern = "[p,P][0-9]$"
+
+ has_period = re.search(period_pattern, entry)
+
+ period = ALL_PERIODS
+ run_number = entry
+ if has_period:
+ run_number = re.sub(period_pattern, "", entry)
+ period_partial = re.sub(run_number, "", entry)
+ period = re.sub("[p,P]", "", period_partial)
+ period = int(period)
+
+ return run_number, period
+
+ @staticmethod
+ def validate_output(output, row_number):
+ # Ensure that sample_scatter was set
+ if not output.sample_scatter:
+ raise ValueError("The sample_scatter entry in row {0} seems to be missing.".format(row_number))
+ if bool(output.sample_transmission) != bool(output.sample_direct):
+ raise ValueError("Inconsistent sample transmission settings in row {0}. Either both the transmission "
+ "and the direct beam run are set or none.".format(row_number))
+ if bool(output.can_transmission) != bool(output.can_direct):
+ raise ValueError("Inconsistent can transmission settings in row {0}. Either both the transmission "
+ "and the direct beam run are set or none.".format(row_number))
+
+ # Ensure that can scatter is specified if the transmissions are set
+ if bool(output.can_transmission) and not bool(output.can_scatter):
+ raise ValueError("The can transmission was set but not the scatter file in row {0}.".format(row_number))
diff --git a/scripts/SANS/sans/command_interface/command_interface_state_director.py b/scripts/SANS/sans/command_interface/command_interface_state_director.py
index b7daed509497e24442a7153e4739bb8a776b4a76..c9cc5ebf5af55e23d734d0f8315a96caf1f872d3 100644
--- a/scripts/SANS/sans/command_interface/command_interface_state_director.py
+++ b/scripts/SANS/sans/command_interface/command_interface_state_director.py
@@ -9,12 +9,15 @@ from __future__ import (absolute_import, division, print_function)
from mantid.py3compat import Enum
from sans.common.enums import DataType
from sans.common.file_information import SANSFileInformationFactory
-from sans.state.data import get_data_builder
+from sans.state.StateRunDataBuilder import StateRunDataBuilder
+from sans.state.StateBuilder import StateBuilder
+from sans.state.StateObjects.StateData import get_data_builder
from sans.user_file.settings_tags import (MonId, monitor_spectrum, OtherId, SampleId, GravityId, SetId, position_entry,
fit_general, FitId, monitor_file, mask_angle_entry, LimitsId, range_entry,
simple_range, DetectorId, event_binning_string_values, det_fit_range,
single_entry_with_detector)
-from sans.user_file.state_director import StateDirectorISIS
+from sans.user_file.txt_parsers.CommandInterfaceAdapter import CommandInterfaceAdapter
+
from sans.user_file.user_file_parser import (UserFileParser)
from sans.user_file.user_file_reader import (UserFileReader)
@@ -250,8 +253,6 @@ class CommandInterfaceStateDirector(object):
file_information_factory = SANSFileInformationFactory()
file_information = file_information_factory.create_sans_file_information(file_name)
- self._state_director = StateDirectorISIS(data_state, file_information)
-
# If we have a clean instruction in there, then we should apply it to all commands
self._apply_clean_if_required()
@@ -264,9 +265,12 @@ class CommandInterfaceStateDirector(object):
process_function = self._method_map[command_id]
process_function(command)
- # The user file state director
- self._state_director.add_state_settings(self._processed_state_settings)
- return self._state_director.construct()
+ user_commands = CommandInterfaceAdapter(data_info=data_state,
+ processed_state=self._processed_state_settings)
+ run_data_parser = StateRunDataBuilder(file_information=file_information)
+
+ self._state_director = StateBuilder(i_state_parser=user_commands, run_data_builder=run_data_parser)
+ return self._state_director.get_all_states()
def _set_up_method_map(self):
"""
diff --git a/scripts/SANS/sans/common/Containers/FloatRange.py b/scripts/SANS/sans/common/Containers/FloatRange.py
new file mode 100644
index 0000000000000000000000000000000000000000..b2ca23ad5f32279ae1584a0c52e6c7a4cf360c1b
--- /dev/null
+++ b/scripts/SANS/sans/common/Containers/FloatRange.py
@@ -0,0 +1,23 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+
+# TODO convert back to NamedTuple with defined types in Python 3
+class FloatRange(object):
+ start = None # : float
+ end= None #: float
+
+ def __init__(self, start, end):
+ self.start = start
+ self.end = end
+
+ def __eq__(self, other):
+ # Ensures a range_entry != FloatRange
+ if isinstance(other, FloatRange):
+ return self.start == other.start and \
+ self.end == other.end
+ return False
diff --git a/scripts/SANS/sans/common/Containers/MonitorID.py b/scripts/SANS/sans/common/Containers/MonitorID.py
new file mode 100644
index 0000000000000000000000000000000000000000..6fdf4d0f2392aab5ef9e68bfa9317f9f2c019a1e
--- /dev/null
+++ b/scripts/SANS/sans/common/Containers/MonitorID.py
@@ -0,0 +1,18 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+
+class MonitorID(object):
+ def __init__(self, monitor_spec_num, monitor_name = None):
+ self.monitor_name = monitor_name
+ self.monitor_spec_num = monitor_spec_num
+
+ def __eq__(self, o): # -> bool:
+ if isinstance(o, MonitorID):
+ return self.monitor_spec_num == o.monitor_spec_num and\
+ self.monitor_name == o.monitor_name
+ return False
diff --git a/scripts/SANS/sans/common/Containers/Position.py b/scripts/SANS/sans/common/Containers/Position.py
new file mode 100644
index 0000000000000000000000000000000000000000..3526a6965283b638372bb93320ab35e6893659d1
--- /dev/null
+++ b/scripts/SANS/sans/common/Containers/Position.py
@@ -0,0 +1,26 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+
+class XYPosition(object):
+ X = None # Float
+ Y = None # Float
+
+ def __init__(self, X, Y):
+ self.X = X
+ self.Y = Y
+
+
+class XYZPosition(object):
+ X = None # Float
+ Y = None # Float
+ Z = None # Float
+
+ def __init__(self, X, Y, Z):
+ self.X = X
+ self.Y = Y
+ self.Z = Z
diff --git a/scripts/SANS/sans/common/Containers/__init__.py b/scripts/SANS/sans/common/Containers/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/scripts/SANS/sans/common/enums.py b/scripts/SANS/sans/common/enums.py
index 0e7a5bde4f7b9ea4de5953ce71e45154c8b118a9..9c4de8d8a4ac337d2d38e9eb63dd770c99660c8a 100644
--- a/scripts/SANS/sans/common/enums.py
+++ b/scripts/SANS/sans/common/enums.py
@@ -7,6 +7,7 @@
""" The elements of this module define typed enums which are used in the SANS reduction framework."""
from __future__ import (absolute_import, division, print_function)
+
from mantid.py3compat import Enum
from sans.state.JsonSerializable import json_serializable
@@ -48,6 +49,21 @@ class CanonicalCoordinates(Enum):
Z = "Z"
+@json_serializable
+class CorrectionType(Enum):
+ X = "X"
+ Y = "Y"
+ Z = "Z"
+
+ X_TILT = "X_TILT"
+ Y_TILT = "Y_TILT"
+
+ RADIUS = "RADIUS"
+ ROTATION = "ROTATION"
+ SIDE = "SIDE"
+ TRANSLATION = "TRANSLATION"
+
+
@json_serializable
class ReductionMode(Enum):
NOT_SET = "Not Set"
@@ -104,6 +120,7 @@ class DetectorType(Enum):
"""
Defines the detector type
"""
+ BOTH = "BOTH"
HAB = "HAB"
LAB = "LAB"
diff --git a/scripts/SANS/sans/common/file_information.py b/scripts/SANS/sans/common/file_information.py
index 6ca8eafe54add6467845137393dbcf7f3b270d3a..8e31c84e4ccc06f6a80f82a1583137aea1875425 100644
--- a/scripts/SANS/sans/common/file_information.py
+++ b/scripts/SANS/sans/common/file_information.py
@@ -98,23 +98,20 @@ def find_sans_file(file_name):
:param file_name: a file name or a run number.
:return: the full path.
"""
- error_message = "Trying to find the SANS file {0}, but cannot find it. Make sure that " \
- "the relevant paths are added and the correct instrument is selected."
- try:
- full_path = find_full_file_path(file_name)
- if not full_path and not file_name.endswith('.nxs'):
- full_path = find_full_file_path(file_name + '.nxs')
- if not full_path:
- # TODO: If we only provide a run number for example 98843 for LOQ measurments, but have LARMOR specified as the
- # Mantid instrument, then the FileFinder will search itself to death. This is a general Mantid issue.
- # One way to handle this graceful would be a timeout option.
- runs = FileFinder.findRuns(file_name)
- if runs:
- full_path = runs[0]
- except RuntimeError:
- raise RuntimeError(error_message.format(file_name))
+ full_path = find_full_file_path(file_name)
+ if not full_path and not file_name.endswith('.nxs'):
+ full_path = find_full_file_path(file_name + '.nxs')
+ if not full_path:
+ # TODO: If we only provide a run number for example 98843 for LOQ measurments, but have LARMOR specified as the
+ # Mantid instrument, then the FileFinder will search itself to death. This is a general Mantid issue.
+ # One way to handle this graceful would be a timeout option.
+ runs = FileFinder.findRuns(file_name)
+ if runs:
+ full_path = runs[0]
if not full_path:
+ error_message = "Trying to find the SANS file {0}, but cannot find it. Make sure that " \
+ "the relevant paths are added and the correct instrument is selected."
raise RuntimeError(error_message.format(file_name))
return full_path
@@ -836,7 +833,7 @@ class SANSFileInformationBlank(SANSFileInformation):
as we should not be creating blank information states
"""
def __init__(self):
- super(SANSFileInformationBlank, self).__init__(full_file_name="0")
+ super(SANSFileInformationBlank, self).__init__(full_file_name="00000")
def get_file_name(self):
raise NotImplementedError("Trying to use blank FileInformation")
diff --git a/scripts/SANS/sans/common/general_functions.py b/scripts/SANS/sans/common/general_functions.py
index e18f1687cf3b32e437581f5fe3c3151fc93c818c..98e28d9309f5db13d208f1302751aa7006f635d8 100644
--- a/scripts/SANS/sans/common/general_functions.py
+++ b/scripts/SANS/sans/common/general_functions.py
@@ -240,31 +240,6 @@ def get_charge_and_time(workspace):
return total_charge, time_passed
-def add_to_sample_log(workspace, log_name, log_value, log_type):
- """
- Adds a sample log to the workspace
-
- :param workspace: the workspace to which the sample log is added
- :param log_name: the name of the log
- :param log_value: the value of the log in string format
- :param log_type: the log value type which can be String, Number, Number Series
- """
- if log_type not in ["String", "Number", "Number Series"]:
- raise ValueError("Tryint go add {0} to the sample logs but it was passed "
- "as an unknown type of {1}".format(log_value, log_type))
- if not isinstance(log_value, str):
- raise TypeError("The value which is added to the sample logs needs to be passed as a string,"
- " but it is passed as {0}".format(type(log_value)))
-
- add_log_name = "AddSampleLog"
- add_log_options = {"Workspace": workspace,
- "LogName": log_name,
- "LogText": log_value,
- "LogType": log_type}
- add_log_alg = create_unmanaged_algorithm(add_log_name, **add_log_options)
- add_log_alg.execute()
-
-
def append_to_sans_file_tag(workspace, to_append):
"""
Appends a string to the existing sans file tag.
diff --git a/scripts/SANS/sans/gui_logic/models/RowEntries.py b/scripts/SANS/sans/gui_logic/models/RowEntries.py
new file mode 100644
index 0000000000000000000000000000000000000000..1e1b84db1780d4e100db21f8024216e6bec3a2b7
--- /dev/null
+++ b/scripts/SANS/sans/gui_logic/models/RowEntries.py
@@ -0,0 +1,112 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+from six import iteritems, iterkeys
+
+from sans.common.enums import RowState, SampleShape
+from sans.common.file_information import SANSFileInformationFactory
+from sans.gui_logic.models.RowOptionsModel import RowOptionsModel
+from mantid.kernel import Logger
+
+
+class _UserEntries(object):
+ """
+ POD type for the row entries found on the main GUI
+ """
+ def __init__(self):
+ self.can_direct = None
+ self.can_scatter = None
+ self.can_transmission = None
+
+ self.sample_direct = None
+ self.sample_scatter = None
+ self.sample_transmission = None
+
+ self.output_name = None
+ self.user_file = None
+
+ self.sample_height = None
+ self._sample_shape = None
+ self.sample_thickness = None
+ self.sample_width = None
+
+ self.can_direct_period = None
+ self.can_scatter_period = None
+ self.can_transmission_period = None
+
+ self.sample_direct_period = None
+ self.sample_scatter_period = None
+ self.sample_transmission_period = None
+
+
+class RowEntries(_UserEntries):
+ _data_vars = vars(_UserEntries())
+ _start_observing = False
+ _logger = Logger("Row Entry")
+
+ def __init__(self, **kwargs):
+ super(RowEntries, self).__init__()
+ self._options = RowOptionsModel()
+
+ self.tool_tip = None
+ self.state = RowState.UNPROCESSED
+
+ self._start_observing = True # Allow init to use setattr without validation
+
+ for k, v in iteritems(kwargs):
+ setattr(self, k, v)
+
+ @property
+ def file_information(self):
+ # TODO this should be removed from row entries - it's an internal state not a GUI one
+ file_factory = SANSFileInformationFactory()
+ return file_factory.create_sans_file_information(self.sample_scatter)
+
+ @property
+ def options(self):
+ return self._options
+
+ @options.setter
+ def options(self, value):
+ assert isinstance(value, RowOptionsModel), \
+ "Expected a RowOptionsModel, got %r" %value
+ self._options = value
+
+ @property
+ def sample_shape(self):
+ return self._sample_shape
+
+ @sample_shape.setter
+ def sample_shape(self, val):
+ if val is SampleShape:
+ self._sample_shape = val
+ return
+
+ try:
+ self._sample_shape = SampleShape(val)
+ except ValueError as e:
+ self._logger.error(str(e))
+ self._sample_shape = None
+
+ def is_multi_period(self):
+ return any((self.sample_scatter_period, self.sample_transmission_period, self.sample_direct_period,
+ self.can_scatter_period, self.can_transmission_period, self.can_direct_period))
+
+ def is_empty(self):
+ return not any(getattr(self, attr) for attr in iterkeys(self._data_vars))
+
+ def reset_row_state(self):
+ self.state = RowState.UNPROCESSED
+ self.tool_tip = None
+
+ def __setattr__(self, key, value):
+ if self._start_observing and key in self._data_vars:
+ self.reset_row_state()
+ if self._start_observing and not hasattr(self, key):
+ raise AttributeError("{0}".format(key))
+
+ return super(RowEntries, self).__setattr__(key, value)
diff --git a/scripts/SANS/sans/gui_logic/models/RowOptionsModel.py b/scripts/SANS/sans/gui_logic/models/RowOptionsModel.py
new file mode 100644
index 0000000000000000000000000000000000000000..4127b9b7522cc70b49a182e5bc70b24fb820639f
--- /dev/null
+++ b/scripts/SANS/sans/gui_logic/models/RowOptionsModel.py
@@ -0,0 +1,89 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+import re
+
+
+class RowOptionsModel(object):
+ def __init__(self):
+ self._user_options = None
+ self._developer_options = {}
+
+ def set_user_options(self, val):
+ self._user_options = val
+
+ def set_developer_option(self, key, value):
+ self._developer_options[key] = value
+
+ def get_displayed_text(self):
+ output = self._user_options + ',' if self._user_options else ''
+ for k, v in self._developer_options.items():
+ output += k + '=' + str(v) + ', '
+
+ if output.endswith(", "):
+ output = output[:-2]
+ return output
+
+ def get_options_dict(self):
+ """
+ Gets all allowed values from the options column.
+ :param options_column_string: the string in the options column
+ :return: a dict with all options
+ """
+ user_text = self.get_displayed_text()
+ if not user_text:
+ return {}
+
+ parsed_options = self._parse_string(user_text)
+ permissible_properties = \
+ {"WavelengthMin": float, "WavelengthMax": float, "EventSlices": str, "MergeScale": float,
+ "MergeShift": float, "PhiMin": float, "PhiMax": float, "UseMirror": bool}
+
+ options = {}
+ for key, value in parsed_options.items():
+ if key == "UseMirror":
+ val = any(v == value for v in ["true", "1", "yes", "True", "t", "y"])
+ if not val and not any(v == value for v in ["false", "0", "no", "f", "n", "False"]):
+ raise ValueError(
+ "Could not evaluate {} as a boolean value. It should be True or False.".format(value))
+ options.update({key: value})
+ continue
+
+ if key in permissible_properties.keys():
+ conversion_type = permissible_properties[key]
+ options.update({key: conversion_type(value)})
+ return options
+
+ @staticmethod
+ def _parse_string(options_column_string):
+ """
+ Parses a string of the form "PropName1=value1,PropName2=value2"
+ :param options_column_string: the string in the options column
+ :return: a dict with parsed values
+ """
+ # Remove all white space
+ parsed = {}
+ options_column_string_no_whitespace = "".join(options_column_string.split())
+ options_column_string_no_whitespace = options_column_string_no_whitespace.replace('"', '')
+ options_column_string_no_whitespace = options_column_string_no_whitespace.replace("'", '')
+
+ if not options_column_string_no_whitespace:
+ return parsed
+
+ # This is a regular expression to detect key value pairs in the options string.
+ # The different parts are:
+ # ([^,=]+) Anything except equals detects keys in the options string
+ # =* then an equals sign
+ # ((?:[^,=]+(?:,|$))*) Any number of repetitions of a string without = followed by a comma or end of input.
+ option_pattern = re.compile(r'''([^,=]+)=*((?:[^,=]+(?:,|$))*)''')
+
+ # The findall option finds all instances of the pattern specified above in the options string.
+ for key, value in option_pattern.findall(options_column_string_no_whitespace):
+ if value.endswith(','):
+ value = value[:-1]
+ parsed.update({key: value})
+
+ return parsed
diff --git a/scripts/SANS/sans/gui_logic/models/batch_process_runner.py b/scripts/SANS/sans/gui_logic/models/batch_process_runner.py
index 095e8519785bc745bbeaa9eac225ce1232976606..5104d997d5e3b50110cf07e6511ab88fda7a0ed7 100644
--- a/scripts/SANS/sans/gui_logic/models/batch_process_runner.py
+++ b/scripts/SANS/sans/gui_logic/models/batch_process_runner.py
@@ -5,10 +5,12 @@
# & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
from qtpy.QtCore import Slot, QThreadPool, Signal, QObject
-from sans.sans_batch import SANSBatchReduction
+from six import itervalues
+
from sans.algorithm_detail.batch_execution import load_workspaces_from_states
-from ui.sans_isis.worker import Worker
from sans.common.enums import ReductionMode
+from sans.sans_batch import SANSBatchReduction
+from ui.sans_isis.worker import Worker
class BatchProcessRunner(QObject):
@@ -33,11 +35,10 @@ class BatchProcessRunner(QObject):
def on_error(self):
self._worker = None
- def process_states(self, rows, get_states_func, get_thickness_for_rows_func, use_optimizations, output_mode, plot_results, output_graph,
+ def process_states(self, row_index_pair, get_states_func, use_optimizations, output_mode, plot_results, output_graph,
save_can=False):
self._worker = Worker(self._process_states_on_thread,
- get_thickness_for_rows_func=get_thickness_for_rows_func,
- rows=rows, get_states_func=get_states_func, use_optimizations=use_optimizations,
+ row_index_pair=row_index_pair, get_states_func=get_states_func, use_optimizations=use_optimizations,
output_mode=output_mode, plot_results=plot_results,
output_graph=output_graph, save_can=save_can)
self._worker.signals.finished.connect(self.on_finished)
@@ -45,50 +46,53 @@ class BatchProcessRunner(QObject):
QThreadPool.globalInstance().start(self._worker)
- def load_workspaces(self, selected_rows, get_states_func, get_thickness_for_rows_func):
+ def load_workspaces(self, row_index_pair, get_states_func):
- self._worker = Worker(self._load_workspaces_on_thread, selected_rows,
- get_states_func, get_thickness_for_rows_func)
+ self._worker = Worker(self._load_workspaces_on_thread, row_index_pair, get_states_func)
self._worker.signals.finished.connect(self.on_finished)
self._worker.signals.error.connect(self.on_error)
QThreadPool.globalInstance().start(self._worker)
- def _process_states_on_thread(self, rows, get_states_func, get_thickness_for_rows_func, use_optimizations, output_mode, plot_results,
- output_graph, save_can=False):
- get_thickness_for_rows_func()
- # The above must finish before we can call get states
- states, errors = get_states_func(row_index=rows)
+ def _process_states_on_thread(self, row_index_pair, get_states_func, use_optimizations,
+ output_mode, plot_results, output_graph, save_can=False):
+ for row, index in row_index_pair:
- for row, error in errors.items():
- self.row_failed_signal.emit(row, error)
+ # TODO update the get_states_func to support one per call
+ states, errors = get_states_func(row_entries=[row])
+
+ assert len(states) + len(errors) == 1, \
+ "Expected 1 error to return got {0}".format(len(states) + len(errors))
+
+ for error in itervalues(errors):
+ self.row_failed_signal.emit(index, error)
+
+ for state in itervalues(states):
+ try:
+ out_scale_factors, out_shift_factors = \
+ self.batch_processor([state], use_optimizations, output_mode, plot_results, output_graph, save_can)
+ except Exception as e:
+ self.row_failed_signal.emit(index, str(e))
+ continue
- for key, state in states.items():
- try:
- out_scale_factors, out_shift_factors = \
- self.batch_processor([state], use_optimizations, output_mode, plot_results, output_graph, save_can)
if state.reduction.reduction_mode == ReductionMode.MERGED:
out_shift_factors = out_shift_factors[0]
out_scale_factors = out_scale_factors[0]
else:
out_shift_factors = []
out_scale_factors = []
- self.row_processed_signal.emit(key, out_shift_factors, out_scale_factors)
-
- except Exception as e:
- self.row_failed_signal.emit(key, str(e))
+ self.row_processed_signal.emit(index, out_shift_factors, out_scale_factors)
- def _load_workspaces_on_thread(self, selected_rows, get_states_func, get_thickness_for_rows_func):
- get_thickness_for_rows_func()
- # The above must finish before we can call get states
- states, errors = get_states_func(row_index=selected_rows)
+ def _load_workspaces_on_thread(self, row_index_pair, get_states_func):
+ for row, index in row_index_pair:
+ states, errors = get_states_func(row_entries=[row])
- for row, error in errors.items():
- self.row_failed_signal.emit(row, error)
+ for error in itervalues(errors):
+ self.row_failed_signal.emit(index, error)
- for key, state in states.items():
- try:
- load_workspaces_from_states(state)
- self.row_processed_signal.emit(key, [], [])
- except Exception as e:
- self.row_failed_signal.emit(key, str(e))
+ for state in itervalues(states):
+ try:
+ load_workspaces_from_states(state)
+ self.row_processed_signal.emit(index, [], [])
+ except Exception as e:
+ self.row_failed_signal.emit(index, str(e))
diff --git a/scripts/SANS/sans/gui_logic/models/beam_centre_model.py b/scripts/SANS/sans/gui_logic/models/beam_centre_model.py
index 8916014f168f9204f1a14d4dd3a730de40344fd1..d96446ac8b35ec3758fd103da4bcc447ff812d31 100644
--- a/scripts/SANS/sans/gui_logic/models/beam_centre_model.py
+++ b/scripts/SANS/sans/gui_logic/models/beam_centre_model.py
@@ -4,34 +4,18 @@
# NScD Oak Ridge National Laboratory, European Spallation Source
# & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
+from mantid.kernel import Logger
from sans.common.enums import (FindDirectionEnum, DetectorType, SANSInstrument)
-from mantid.kernel import (Logger)
-from sans.common.file_information import get_instrument_paths_for_sans_file
-from sans.common.xml_parsing import get_named_elements_from_ipf_file
class BeamCentreModel(object):
+ logger = Logger("CentreFinder")
+
def __init__(self, SANSCentreFinder):
super(BeamCentreModel, self).__init__()
- self.reset_to_defaults_for_instrument()
- self.SANSCentreFinder = SANSCentreFinder
-
- def __eq__(self, other):
- return self.__dict__ == other.__dict__
-
- def reset_to_defaults_for_instrument(self, file_information = None):
- r_range = {}
- instrument = None
-
- if file_information:
- instrument_file_path = get_instrument_paths_for_sans_file(file_information=file_information)
- r_range = get_named_elements_from_ipf_file(instrument_file_path[1],
- ["beam_centre_radius_min", "beam_centre_radius_max"], float)
- instrument = file_information.get_instrument()
-
self._max_iterations = 10
- self._r_min = r_range["beam_centre_radius_min"] if "beam_centre_radius_min" in r_range else 60
- self._r_max = r_range["beam_centre_radius_max"] if "beam_centre_radius_max" in r_range else 280
+ self._r_min = 0
+ self._r_max = 0
self._left_right = True
self._up_down = True
self._tolerance = 0.0001251
@@ -49,8 +33,25 @@ class BeamCentreModel(object):
self.update_lab = True
self.update_hab = True
- if instrument == SANSInstrument.LARMOR:
- self.scale_1 = 1.0
+ self.reset_inst_defaults(instrument=SANSInstrument.NO_INSTRUMENT)
+
+ self.SANSCentreFinder = SANSCentreFinder
+
+ def __eq__(self, other):
+ return self.__dict__ == other.__dict__
+
+ def reset_inst_defaults(self, instrument):
+ if instrument is SANSInstrument.LOQ:
+ self._r_min = 96
+ self._r_max = 216
+
+ # TODO HAB on LOQ prefers 96-750
+ else:
+ # All other instruments hard-code this as follows
+ self._r_min = 60
+ self._r_max = 280
+
+ self.set_scaling(instrument=instrument)
def set_scaling(self, instrument):
self.scale_1 = 1000
@@ -76,8 +77,7 @@ class BeamCentreModel(object):
elif self.left_right:
find_direction = FindDirectionEnum.LEFT_RIGHT
else:
- logger = Logger("CentreFinder")
- logger.notice("Have chosen no find direction exiting early")
+ self.logger.notice("Have chosen no find direction exiting early")
return {"pos1": self.lab_pos_1, "pos2": self.lab_pos_2}
if self.COM:
diff --git a/scripts/SANS/sans/gui_logic/models/create_state.py b/scripts/SANS/sans/gui_logic/models/create_state.py
index 322c07493d5eccc9758ce533b37a0627d71d4f52..3d7c68e995ff29776b2ba2ecbf5f9d282fc2dafa 100644
--- a/scripts/SANS/sans/gui_logic/models/create_state.py
+++ b/scripts/SANS/sans/gui_logic/models/create_state.py
@@ -11,62 +11,82 @@ from sans.gui_logic.models.state_gui_model import StateGuiModel
from sans.gui_logic.presenter.gui_state_director import (GuiStateDirector)
from sans.user_file.user_file_reader import UserFileReader
from mantid.kernel import Logger
-from sans.state.state import State
+from sans.state.AllStates import AllStates
sans_logger = Logger("SANS")
-def create_states(state_model, table_model, instrument, facility, row_index=None,
- file_lookup=True, user_file=""):
+def create_states(state_model, facility, row_entries=None, file_lookup=True, user_file=""):
"""
Here we create the states based on the settings in the models
:param state_model: the state model object
- :param table_model: the table model object
- :param row_index: the selected row, if None then all rows are generated
+ :param row_entries: a list of row entry objects to create state for
:param user_file: the user file under which the data is reduced
"""
- number_of_rows = table_model.get_number_of_rows()
- rows = [x for x in row_index if x < number_of_rows]
states = {}
errors = {}
- gui_state_director = GuiStateDirector(table_model, state_model, facility)
- for row in rows:
- if file_lookup:
- table_model.wait_for_file_information(row)
- state = _create_row_state(row, table_model, state_model, facility, instrument, file_lookup,
+ gui_state_director = GuiStateDirector(state_model, facility)
+ for row in row_entries:
+ _get_thickness_for_row(row)
+
+ state = _create_row_state(row, state_model, facility, file_lookup,
gui_state_director, user_file)
- if isinstance(state, State):
+ if isinstance(state, AllStates):
states.update({row: state})
elif isinstance(state, str):
errors.update({row: state})
return states, errors
-def _create_row_state(row, table_model, state_model, facility, instrument, file_lookup,
+def _get_thickness_for_row(row):
+ """
+ Read in the sample thickness for the given rows from the file and set it in the table.
+ :param row: Row to update with file information
+ """
+ if row.is_empty():
+ return
+
+ file_info = row.file_information
+
+ for attr in ["sample_thickness", "sample_height", "sample_width"]:
+ original_val = getattr(row, attr)
+ converted = float(original_val) if original_val else None
+ setattr(row, attr, converted)
+
+ thickness = float(row.sample_thickness) if row.sample_thickness \
+ else round(file_info.get_thickness(), 2)
+ height = float(row.sample_height) if row.sample_height else round(file_info.get_height(), 2)
+ width = float(row.sample_width) if row.sample_width else round(file_info.get_width(), 2)
+
+ row.sample_thickness = thickness
+ row.sample_height = height
+ row.sample_width = width
+ if not row.sample_shape:
+ row.sample_shape = file_info.get_shape()
+
+
+def _create_row_state(row_entry, state_model, facility, file_lookup,
gui_state_director, user_file):
- sans_logger.information("Generating state for row {}".format(row))
+ sans_logger.information("Generating state for row {}".format(row_entry))
state = None
try:
-
- table_entry = table_model.get_table_entry(row)
- if not table_entry.file_information and file_lookup:
+ if not row_entry.file_information and file_lookup:
error_message = "Trying to find the SANS file {0}, but cannot find it. Make sure that " \
"the relevant paths are added and the correct instrument is selected."
- raise RuntimeError(error_message.format(table_entry.sample_scatter))
+ raise RuntimeError(error_message.format(row_entry.sample_scatter))
- if not __is_empty_row(row, table_model):
- row_user_file = table_model.get_row_user_file(row)
+ if not row_entry.is_empty():
+ row_user_file = row_entry.user_file
if row_user_file:
row_state_model = create_gui_state_from_userfile(row_user_file, state_model)
- row_gui_state_director = GuiStateDirector(table_model, row_state_model, facility)
- state = row_gui_state_director.create_state(row, instrument=instrument, file_lookup=file_lookup,
+ row_gui_state_director = GuiStateDirector(row_state_model, facility)
+ state = row_gui_state_director.create_state(row_entry, file_lookup=file_lookup,
user_file=row_user_file)
else:
- state = gui_state_director.create_state(row, instrument=instrument, file_lookup=file_lookup,
- user_file=user_file)
+ state = gui_state_director.create_state(row_entry, file_lookup=file_lookup, user_file=user_file)
return state
except (ValueError, RuntimeError) as e:
return "{}".format(str(e))
diff --git a/scripts/SANS/sans/gui_logic/models/diagnostics_page_model.py b/scripts/SANS/sans/gui_logic/models/diagnostics_page_model.py
index 5971b0704ab885426f206f9fd97a74bf09e3faa9..bf40496e41140b6f6739da00740e2ee458206565 100644
--- a/scripts/SANS/sans/gui_logic/models/diagnostics_page_model.py
+++ b/scripts/SANS/sans/gui_logic/models/diagnostics_page_model.py
@@ -15,9 +15,9 @@ from sans.common.enums import IntegralEnum, DetectorType, SANSDataType
from sans.common.file_information import get_instrument_paths_for_sans_file
from sans.common.general_functions import parse_diagnostic_settings
from sans.common.xml_parsing import get_named_elements_from_ipf_file
+from sans.gui_logic.models.RowEntries import RowEntries
from sans.gui_logic.plotting import get_plotting_module
-from sans.gui_logic.models.table_model import TableModel, TableIndexModel
-from sans.gui_logic.presenter.gui_state_director import (GuiStateDirector)
+from sans.gui_logic.presenter.gui_state_director import GuiStateDirector
def run_integral(integral_ranges, mask, integral, detector, state):
@@ -162,12 +162,9 @@ def get_detector_size_from_sans_file(state, detector):
def create_state(state_model_with_view_update, file, period, facility):
- table_row = TableIndexModel(file, period, '', '', '', '', '', '', '', '', '', '')
- table = TableModel()
- table.add_table_entry_no_thread_or_signal(0, table_row)
+ table_row = RowEntries(sample_scatter=file, sample_scatter_period=period)
+ gui_state_director = GuiStateDirector(state_model_with_view_update, facility)
- gui_state_director = GuiStateDirector(table, state_model_with_view_update, facility)
-
- state = gui_state_director.create_state(0)
+ state = gui_state_director.create_state(table_row)
return state
diff --git a/scripts/SANS/sans/gui_logic/models/table_model.py b/scripts/SANS/sans/gui_logic/models/table_model.py
index 5dfab8947fc8c672a857011bae3e9384fea11c25..14751663e3d5dea13e5fadc9819a7b2d6509ce21 100644
--- a/scripts/SANS/sans/gui_logic/models/table_model.py
+++ b/scripts/SANS/sans/gui_logic/models/table_model.py
@@ -12,15 +12,10 @@ information regarding the custom output name and the information in the options
from __future__ import (absolute_import, division, print_function)
-import os
-import re
-
-from mantid.py3compat import Enum
from mantid.kernel import Logger
-from sans.common.constants import ALL_PERIODS
-from sans.common.enums import RowState, SampleShape
-from sans.common.file_information import SANSFileInformationFactory
-from ui.sans_isis.work_handler import WorkHandler
+from sans.common.enums import RowState
+from sans.gui_logic.models.RowEntries import RowEntries
+from sans.gui_logic.models.basic_hint_strategy import BasicHintStrategy
class TableModel(object):
@@ -34,31 +29,15 @@ class TableModel(object):
logger = Logger("ISIS SANS GUI")
- def __init__(self, file_information_factory=SANSFileInformationFactory()):
+ def __init__(self):
super(TableModel, self).__init__()
- self._user_file = ""
- self._batch_file = ""
- self._table_entries = []
- self.work_handler = WorkHandler()
+ self.batch_file = ""
+ self.user_file = ""
self._subscriber_list = []
- self._id_count = 0
-
- self._file_information = file_information_factory
-
- @staticmethod
- def _validate_file_name(file_name):
- if not file_name:
- return
- if not os.path.exists(file_name):
- raise ValueError("The file {} does not seem to exist.".format(file_name))
-
- @property
- def user_file(self):
- return self._user_file
- @user_file.setter
- def user_file(self, value):
- self._user_file = value
+ self._table_entries = []
+ self._default_entry_added = None
+ self.clear_table_entries()
def get_row_user_file(self, row_index):
if row_index < len(self._table_entries):
@@ -66,355 +45,84 @@ class TableModel(object):
else:
raise IndexError("The row {} does not exist.".format(row_index))
- @property
- def batch_file(self):
- return self._batch_file
-
- @batch_file.setter
- def batch_file(self, value):
- self._batch_file = value
-
- def get_table_entry(self, index):
- return self._table_entries[index]
-
def add_multiple_table_entries(self, table_index_model_list):
- for index, current_row in enumerate(table_index_model_list):
- self._add_single_table_entry(row=index, table_index_model=current_row)
-
+ for row in table_index_model_list:
+ self._add_single_table_entry(row_entry=row)
self.notify_subscribers()
- def add_table_entry(self, row, table_index_model):
- self._add_single_table_entry(row=row, table_index_model=table_index_model)
- self.notify_subscribers()
-
- def _add_single_table_entry(self, row, table_index_model):
- table_index_model.id = self._id_count
- self._id_count += 1
- self._table_entries.insert(row, table_index_model)
-
- # Ensure state is created correctly if we have any values
- if table_index_model.sample_scatter:
- table_index_model.file_finding = False
-
def append_table_entry(self, table_index_model):
- table_index_model.id = self._id_count
- self._id_count += 1
- self._table_entries.append(table_index_model)
- self.notify_subscribers()
-
- def remove_table_entries(self, rows):
- # For speed rows should be a Set here but don't think it matters for the list sizes involved.
- self._table_entries[:] = [item for i, item in enumerate(self._table_entries) if i not in rows]
- if not self._table_entries:
- row_index_model = self.create_empty_row()
- self.append_table_entry(row_index_model)
- else:
- self.notify_subscribers()
-
- def replace_table_entries(self, row_to_replace_index, rows_to_insert):
- self.remove_table_entries(row_to_replace_index)
- for row_entry in reversed(rows_to_insert):
- self.add_table_entry(row_to_replace_index[0], row_entry)
-
- def clear_table_entries(self):
- self._table_entries = []
- row_index_model = self.create_empty_row()
- self.append_table_entry(row_index_model)
-
- def get_number_of_rows(self):
- return len(self._table_entries)
-
- def update_table_entry(self, row, column, value):
- self._table_entries[row].update_attribute(self.column_name_converter[column], value)
- self._table_entries[row].update_attribute('row_state', RowState.UNPROCESSED)
- self._table_entries[row].update_attribute('tool_tip', '')
+ self._add_single_table_entry(row_entry=table_index_model)
self.notify_subscribers()
- def is_empty_row(self, row):
- return self._table_entries[row].is_empty()
-
- @staticmethod
- def create_empty_row():
- row = [''] * 16
- return TableIndexModel(*row)
-
- def get_non_empty_rows(self, rows):
- return list(filter(lambda x: not self.get_table_entry(x).is_empty(), rows))
+ def get_all_rows(self):
+ return self._table_entries
- def get_options_hint_strategy(self):
- return OptionsColumnModel.get_hint_strategy()
+ def get_row(self, index):
+ return self._table_entries[index]
- def get_sample_shape_hint_strategy(self):
- return SampleShapeColumnModel.get_hint_strategy()
+ def get_row_index(self, row):
+ return self._table_entries.index(row)
- def set_row_to_processed(self, row, tool_tip):
- self._table_entries[row].update_attribute('row_state', RowState.PROCESSED)
- self._table_entries[row].update_attribute('tool_tip', tool_tip)
+ def insert_row_at(self, row_index, row_entry):
+ # Insert a None to effectively bookmark the space
+ self._table_entries.insert(row_index, None)
+ self._add_single_table_entry(row_entry=row_entry, row_index=row_index)
self.notify_subscribers()
- def reset_row_state(self, row):
- self._table_entries[row].update_attribute('row_state', RowState.UNPROCESSED)
- self._table_entries[row].update_attribute('tool_tip', '')
-
- def set_row_to_error(self, row, tool_tip):
- self._table_entries[row].update_attribute('row_state', RowState.ERROR)
- self._table_entries[row].update_attribute('tool_tip', tool_tip)
+ def replace_table_entry(self, row_index, row_entry):
+ self._add_single_table_entry(row_index=row_index, row_entry=row_entry)
self.notify_subscribers()
- def get_thickness_for_rows(self, rows=None):
- """
- Read in the sample thickness for the given rows from the file and set it in the table.
- :param rows: list of table rows
- """
- if not rows:
- rows = range(len(self._table_entries))
-
- for row in rows:
- entry = self._table_entries[row]
- if entry.is_empty():
- continue
- entry.file_finding = True
-
- try:
- file_info = self._file_information.create_sans_file_information(entry.sample_scatter)
- except RuntimeError:
- continue
-
- self.update_thickness_from_file_information(id=entry.id, file_information=file_info)
-
- def failure_handler(self, id, error):
- row = self.get_row_from_id(id)
-
- self._table_entries[row].update_attribute('file_information', '')
- self._table_entries[row].update_attribute('sample_thickness', '')
- self._table_entries[row].update_attribute('sample_height', '')
- self._table_entries[row].update_attribute('sample_width', '')
- self._table_entries[row].update_attribute('sample_shape', '')
- self._table_entries[row].file_finding = False
- self.set_row_to_error(row, str(error[1]))
+ def remove_table_entries(self, row_indices):
+ new_table_entries = [item for i, item in enumerate(self._table_entries) if i not in row_indices]
- @staticmethod
- def convert_to_float_or_return_none(val):
- """
- Attempts to convert to a float or return None
- :param val: The value to convert
- :return: The float or None if the conversion failed
- """
- try:
- converted_val = float(val)
- return converted_val
- except ValueError:
- return None
-
- def update_thickness_from_file_information(self, id, file_information):
-
- row = self.get_row_from_id(id)
- entry = self._table_entries[row]
-
- for attr in ["sample_thickness", "sample_height", "sample_width"]:
- original_val = getattr(entry, attr)
- converted = self.convert_to_float_or_return_none(original_val)
- setattr(entry, attr, converted)
- if converted is None and original_val:
- self.logger.warning(
- "The {0} entered ({1}) could not be converted to a length. Using the one from the original sample."
- .format(attr.replace('_', ' '), original_val))
-
- thickness = float(entry.sample_thickness) if entry.sample_thickness else round(file_information.get_thickness(),
- 2)
- height = float(entry.sample_height) if entry.sample_height else round(file_information.get_height(), 2)
- width = float(entry.sample_width) if entry.sample_width else round(file_information.get_width(), 2)
-
- if file_information:
- self._table_entries[row].update_attribute('file_information', file_information)
- self._table_entries[row].update_attribute('sample_thickness', thickness)
- self._table_entries[row].update_attribute('sample_height', height)
- self._table_entries[row].update_attribute('sample_width', width)
- if self._table_entries[row].sample_shape_string == "":
- self._table_entries[row].update_attribute('sample_shape', file_information.get_shape())
- self._table_entries[row].file_finding = False
- self.reset_row_state(row)
-
- def subscribe_to_model_changes(self, subscriber):
- self._subscriber_list.append(subscriber)
-
- def notify_subscribers(self):
- for subscriber in self._subscriber_list:
- subscriber.on_update_rows()
-
- def get_file_information_for_row(self, row):
- return self._table_entries[row].file_information
-
- def get_row_from_id(self, id):
- for row, entry in enumerate(self._table_entries):
- if entry.id == id:
- return row
- return None
+ if not new_table_entries:
+ self.clear_table_entries()
+ else:
+ self._table_entries = new_table_entries
- def wait_for_file_finding_done(self):
- self.work_handler.wait_for_done()
+ self.notify_subscribers()
- def wait_for_file_information(self, row):
- if self._table_entries[row].file_finding:
- self.wait_for_file_finding_done()
+ def _add_single_table_entry(self, row_entry, row_index=None):
+ assert isinstance(row_entry, RowEntries), \
+ "%r is not a RowEntries object" % row_entry
- def add_table_entry_no_thread_or_signal(self, row, table_index_model):
- table_index_model.id = self._id_count
- self._id_count += 1
- self._table_entries.insert(row, table_index_model)
- if row >= self.get_number_of_rows():
- row = self.get_number_of_rows() - 1
+ assert len(self._table_entries) >= 1, \
+ "There must always be 1 element in the model, currently there is 0"
- entry = self._table_entries[row]
- file_information = self._file_information.create_sans_file_information(entry.sample_scatter)
- self.update_thickness_from_file_information(entry.id, file_information)
+ if self._default_entry_added:
+ del self._table_entries[0]
+ self._default_entry_added = False
- def set_option(self, row, key, value):
- self._table_entries[row].options_column_model.set_option(key, value)
+ if row_index is None or row_index == len(self._table_entries):
+ return self._table_entries.append(row_entry)
- def __eq__(self, other):
- return self.equal_dicts(self.__dict__, other.__dict__, ['work_handler'])
+ self._table_entries[row_index] = row_entry
- def __ne__(self, other):
- return not self.equal_dicts(self.__dict__, other.__dict__, ['work_handler'])
-
- @staticmethod
- def equal_dicts(d1, d2, ignore_keys):
- d1_filtered = dict((k, v) for k, v in d1.items() if k not in ignore_keys)
- d2_filtered = dict((k, v) for k, v in d2.items() if k not in ignore_keys)
- return d1_filtered == d2_filtered
+ def replace_table_entries(self, row_to_replace_index, rows_to_insert):
+ starting_index = row_to_replace_index[0]
+ for i, row_entry in enumerate(reversed(rows_to_insert)):
+ self.replace_table_entry(starting_index + i, row_entry)
+ def clear_table_entries(self):
+ self._table_entries = [RowEntries()]
+ self._default_entry_added = True
+ self.notify_subscribers()
-class TableIndexModel(object):
- def __init__(self, sample_scatter, sample_scatter_period,
- sample_transmission, sample_transmission_period,
- sample_direct, sample_direct_period,
- can_scatter, can_scatter_period,
- can_transmission, can_transmission_period,
- can_direct, can_direct_period,
- output_name="", user_file="", sample_thickness='', sample_height='', sample_width='',
- sample_shape='', options_column_string=""):
- super(TableIndexModel, self).__init__()
- self.id = None
- self.sample_scatter = sample_scatter
- self.sample_scatter_period = sample_scatter_period
- self.sample_transmission = sample_transmission
- self.sample_transmission_period = sample_transmission_period
- self.sample_direct = sample_direct
- self.sample_direct_period = sample_direct_period
-
- self.can_scatter = can_scatter
- self.can_scatter_period = can_scatter_period
- self.can_transmission = can_transmission
- self.can_transmission_period = can_transmission_period
- self.can_direct = can_direct
- self.can_direct_period = can_direct_period
-
- self.user_file = user_file
- self.sample_thickness = sample_thickness
- self.sample_height = sample_height
- self.sample_width = sample_width
- self.output_name = output_name
-
- self.options_column_model = options_column_string
- self.sample_shape_model = SampleShapeColumnModel()
- self.sample_shape = sample_shape
-
- self.row_state = RowState.UNPROCESSED
-
- self.tool_tip = ''
- self.file_information = None
- self.file_finding = False
-
- # Options column entries
- @property
- def options_column_model(self):
- return self._options_column_model
-
- @options_column_model.setter
- def options_column_model(self, value):
- self._options_column_model = OptionsColumnModel(value)
-
- # Sample shape
- @property
- def sample_shape_string(self):
- return self.sample_shape_model.sample_shape_string
-
- @property
- def sample_shape(self):
- return self.sample_shape_model.sample_shape
-
- @sample_shape.setter
- def sample_shape(self, value):
- self.sample_shape_model(value)
-
- def update_attribute(self, attribute_name, value):
- setattr(self, attribute_name, value)
+ def get_number_of_rows(self):
+ if self._default_entry_added:
+ return 0
- def __eq__(self, other):
- return self.__dict__ == other.__dict__
+ return len(self._table_entries)
- def __ne__(self, other):
- return self.__dict__ != other.__dict__
-
- def to_list(self):
- return [self.sample_scatter, self._string_period(self.sample_scatter_period), self.sample_transmission,
- self._string_period(self.sample_transmission_period), self.sample_direct,
- self._string_period(self.sample_direct_period), self.can_scatter,
- self._string_period(self.can_scatter_period), self.can_transmission,
- self._string_period(self.can_transmission_period), self.can_direct,
- self._string_period(self.can_direct_period), self.output_name, self.user_file, self.sample_thickness,
- self.sample_height, self.sample_width,
- self.sample_shape_string,
- self.options_column_model.get_options_string()]
-
- def to_batch_list(self):
- """
- Return a list of data in the order as would typically appear in the batch file
- :return: a list containing entries in the row present in the batch file
- """
- return_list = [self.sample_scatter, self.sample_transmission,
- self.sample_direct, self.can_scatter, self.can_transmission,
- self.can_direct, self.output_name, self.user_file, self.sample_thickness, self.sample_height,
- self.sample_width]
- return list(map(lambda item: str(item).strip(), return_list))
-
- def isMultiPeriod(self):
- return any((self.sample_scatter_period, self.sample_transmission_period, self.sample_direct_period,
- self.can_scatter_period, self.can_transmission_period, self.can_direct_period))
-
- def is_empty(self):
- return not any((self.sample_scatter, self.sample_transmission, self.sample_direct, self.can_scatter,
- self.can_transmission, self.can_direct))
-
- def _string_period(self, _tag):
- return "" if _tag == ALL_PERIODS else str(_tag)
-
-
-class OptionsColumnModel(object):
- def __init__(self, options_column_string):
- super(OptionsColumnModel, self).__init__()
- self._options_column_string = options_column_string
- self._options = self._get_options(self._options_column_string)
-
- def get_options(self):
- return self._options
-
- def set_option(self, key, value):
- self._options.update({key: value})
-
- def get_options_string(self):
- return self._serialise_options_dict()
+ def is_empty_row(self, row):
+ return self._table_entries[row].is_empty()
- @staticmethod
- def _get_permissible_properties():
- return {"WavelengthMin": float, "WavelengthMax": float, "EventSlices": str, "MergeScale": float,
- "MergeShift": float, "PhiMin": float, "PhiMax": float, "UseMirror": options_column_bool}
+ def get_non_empty_rows(self):
+ return [x for x in self._table_entries if not x.is_empty()]
@staticmethod
- def get_hint_strategy():
- from sans.gui_logic.models.basic_hint_strategy import BasicHintStrategy
-
+ def get_options_hint_strategy():
return BasicHintStrategy({"WavelengthMin": 'The min value of the wavelength when converting from TOF.',
"WavelengthMax": 'The max value of the wavelength when converting from TOF.',
"PhiMin": 'The min angle of the detector to accept.'
@@ -430,127 +138,48 @@ class OptionsColumnModel(object):
'it must be enclosed in quotes'})
@staticmethod
- def _parse_string(options_column_string):
- """
- Parses a string of the form "PropName1=value1,PropName2=value2"
- :param options_column_string: the string in the options column
- :return: a dict with parsed values
- """
- # Remove all white space
- parsed = {}
- options_column_string_no_whitespace = "".join(options_column_string.split())
- options_column_string_no_whitespace = options_column_string_no_whitespace.replace('"', '')
- options_column_string_no_whitespace = options_column_string_no_whitespace.replace("'", '')
-
- if not options_column_string_no_whitespace:
- return parsed
-
- # This is a regular expression to detect key value pairs in the options string.
- # The different parts are:
- # ([^,=]+) Anything except equals detects keys in the options string
- # =* then an equals sign
- # ((?:[^,=]+(?:,|$))*) Any number of repetitions of a string without = followed by a comma or end of input.
- option_pattern = re.compile(r'''([^,=]+)=*((?:[^,=]+(?:,|$))*)''')
-
- # The findall option finds all instances of the pattern specified above in the options string.
- for key, value in option_pattern.findall(options_column_string_no_whitespace):
- if value.endswith(','):
- value = value[:-1]
- parsed.update({key: value})
-
- return parsed
-
- def _serialise_options_dict(self):
- return ', '.join(['{}={}'.format(k, self._options[k]) for k in sorted(self._options)])
-
- @staticmethod
- def _get_options(options_column_string):
- """
- Gets all allowed values from the options column.
-
- :param options_column_string: the string in the options column
- :return: a dict with all options
- """
- parsed_options = OptionsColumnModel._parse_string(options_column_string)
- permissible_properties = OptionsColumnModel._get_permissible_properties()
-
- options = {}
- for key, value in parsed_options.items():
- if key in permissible_properties.keys():
- conversion_functions = permissible_properties[key]
- options.update({key: conversion_functions(value)})
- return options
-
- def __eq__(self, other):
- return self.__dict__ == other.__dict__
-
- def __ne__(self, other):
- return self.__dict__ != other.__dict__
-
-
-class SampleShapeColumnModel(object):
- SAMPLE_SHAPES = ["cylinder", "disc", "flatplate"]
- SAMPLE_SHAPES_DICT = {"cylinder": "Cylinder",
- "disc": "Disc",
- "flatplate": "FlatPlate"}
-
- def __init__(self):
- self.sample_shape = ""
- self.sample_shape_string = ""
-
- def __call__(self, original_value):
- self._set_sample_shape(original_value)
-
- def _set_sample_shape(self, original_value):
- if isinstance(original_value, Enum):
- self.sample_shape = original_value
- self.sample_shape_string = original_value.value
- return
+ def get_sample_shape_hint_strategy():
+ return BasicHintStrategy({"Cylinder": "",
+ "Disc": "",
+ "FlatPlate": ""})
- user_val = original_value.strip().lower()
+ def set_row_to_processed(self, row, tool_tip):
+ self._table_entries[row].state = RowState.PROCESSED
+ self._table_entries[row].tool_tip = tool_tip
+ self.notify_subscribers()
- # Set it to none as our fallback
- self.sample_shape = SampleShape.NOT_SET
- self.sample_shape_string = ""
+ def reset_row_state(self, row):
+ self._table_entries[row].state = RowState.UNPROCESSED
+ self._table_entries[row].tool_tip = None
- if not user_val:
- return # If we don't return here an empty string will match with the first shape
+ def set_row_to_error(self, row, msg):
+ self._table_entries[row].state = RowState.ERROR
+ self._table_entries[row].tool_tip = msg
+ self.notify_subscribers()
- for shape in SampleShape:
- # Case insensitive lookup
- value = str(shape.value)
- if user_val in value.lower() :
- self.sample_shape = shape
- self.sample_shape_string = shape.value
- return
+ def failure_handler(self, entry, error):
+ entry.file_information = None
+ entry.sample_thickness = None
+ entry.sample_height = None
+ entry.sample_width = None
+ entry.sample_shape = None
+ self.set_row_to_error(entry, str(error[1]))
- @staticmethod
- def get_hint_strategy():
- from sans.gui_logic.models.basic_hint_strategy import BasicHintStrategy
+ def subscribe_to_model_changes(self, subscriber):
+ self._subscriber_list.append(subscriber)
- return BasicHintStrategy({"Cylinder": "",
- "Disc": "",
- "FlatPlate": ""})
+ def notify_subscribers(self):
+ for subscriber in self._subscriber_list:
+ subscriber.on_update_rows()
def __eq__(self, other):
- return self.__dict__ == other.__dict__
+ return self.equal_dicts(self.__dict__, other.__dict__, ['work_handler'])
def __ne__(self, other):
- return self.__dict__ != other.__dict__
-
-
-def options_column_bool(string):
- """
- Evaluate input string as a bool. Used for UseMirror in Options column,
- as evaluating bool("False") returns True (any string is Truthy).
- :param string: User input string to be evaluated as False or True
- :return: True or False
- """
- truthy_strings = ("true", "1", "yes", "t", "y") # t short for true, y short for yes
- falsy_strings = ("false", "0", "no", "f", "n")
- if string.lower() in truthy_strings:
- return True
- elif string.lower() in falsy_strings:
- return False
- else:
- raise ValueError("Could not evaluate {} as a boolean value. It should be True or False.".format(string))
+ return not self.equal_dicts(self.__dict__, other.__dict__, ['work_handler'])
+
+ @staticmethod
+ def equal_dicts(d1, d2, ignore_keys):
+ d1_filtered = dict((k, v) for k, v in d1.items() if k not in ignore_keys)
+ d2_filtered = dict((k, v) for k, v in d2.items() if k not in ignore_keys)
+ return d1_filtered == d2_filtered
diff --git a/scripts/SANS/sans/gui_logic/presenter/work_handler_listener_wrapper.py b/scripts/SANS/sans/gui_logic/presenter/GenericWorkHandlerListener.py
similarity index 100%
rename from scripts/SANS/sans/gui_logic/presenter/work_handler_listener_wrapper.py
rename to scripts/SANS/sans/gui_logic/presenter/GenericWorkHandlerListener.py
diff --git a/scripts/SANS/sans/gui_logic/presenter/beam_centre_presenter.py b/scripts/SANS/sans/gui_logic/presenter/beam_centre_presenter.py
index 7e0512ea08f785d616bb1001bd463530f026884d..a23607a61e0e2100222a836c733b228adc5a3774 100644
--- a/scripts/SANS/sans/gui_logic/presenter/beam_centre_presenter.py
+++ b/scripts/SANS/sans/gui_logic/presenter/beam_centre_presenter.py
@@ -9,6 +9,7 @@ from __future__ import (absolute_import, division, print_function)
import copy
from mantid.kernel import Logger
+from sans.gui_logic.models.beam_centre_model import BeamCentreModel
from ui.sans_isis.beam_centre import BeamCentre
from ui.sans_isis.work_handler import WorkHandler
@@ -32,12 +33,12 @@ class BeamCentrePresenter(object):
def on_processing_error(self, error):
self._presenter.on_processing_error_centre_finder(error)
- def __init__(self, parent_presenter, WorkHandler, BeamCentreModel, SANSCentreFinder):
+ def __init__(self, parent_presenter, SANSCentreFinder, work_handler=None, beam_centre_model=None):
self._view = None
self._parent_presenter = parent_presenter
- self._work_handler = WorkHandler()
+ self._work_handler = WorkHandler() if not work_handler else work_handler
self._logger = Logger("SANS")
- self._beam_centre_model = BeamCentreModel(SANSCentreFinder)
+ self._beam_centre_model = BeamCentreModel(SANSCentreFinder) if not beam_centre_model else beam_centre_model
def set_view(self, view):
if view:
@@ -62,10 +63,7 @@ class BeamCentrePresenter(object):
self._view.on_update_instrument(instrument)
def on_update_rows(self):
- file_information = self._parent_presenter._table_model.get_file_information_for_row(0)
- if file_information:
- self._beam_centre_model.reset_to_defaults_for_instrument(file_information=file_information)
- self._view.set_options(self._beam_centre_model)
+ self._beam_centre_model.reset_inst_defaults(self._parent_presenter.instrument)
def on_processing_finished_centre_finder(self, result):
# Enable button
@@ -90,6 +88,8 @@ class BeamCentrePresenter(object):
self._view.set_run_button_to_normal()
def on_run_clicked(self):
+ self._work_handler.wait_for_done()
+
# Get the state information for the first row.
state = self._parent_presenter.get_state_for_row(0)
@@ -188,6 +188,10 @@ class BeamCentrePresenter(object):
# one of the values is empty
pass
else:
+ if min_value == max_value == 0:
+ self._view.run_button.setEnabled(False)
+ return
+
if min_value >= max_value:
if self._view.run_button.isEnabled():
# Only post to logger once per disabling
diff --git a/scripts/SANS/sans/gui_logic/presenter/gui_state_director.py b/scripts/SANS/sans/gui_logic/presenter/gui_state_director.py
index 9ebbf7524d52e3b741b108b871f9edb889d283b6..ca7685e145fad929452551e67feafffe95d19fa3 100644
--- a/scripts/SANS/sans/gui_logic/presenter/gui_state_director.py
+++ b/scripts/SANS/sans/gui_logic/presenter/gui_state_director.py
@@ -14,72 +14,70 @@ from __future__ import (absolute_import, division, print_function)
import copy
-from sans.common.enums import (SANSInstrument)
from sans.common.file_information import SANSFileInformationBlank
-from sans.state.data import get_data_builder
-from sans.user_file.state_director import StateDirectorISIS
+from sans.state.StateRunDataBuilder import StateRunDataBuilder
+from sans.state.StateBuilder import StateBuilder
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.user_file.txt_parsers.CommandInterfaceAdapter import CommandInterfaceAdapter
class GuiStateDirector(object):
- def __init__(self, table_model, state_gui_model, facility):
- self._table_model = table_model
+ def __init__(self, state_gui_model, facility):
self._state_gui_model = state_gui_model
self._facility = facility
def __eq__(self, other):
return self.__dict__ == other.__dict__
- def create_state(self, row, file_lookup=True, instrument=SANSInstrument.SANS2D,
- user_file=""):
+ def create_state(self, row_entry, file_lookup=True, user_file=""):
# 1. Get the data settings, such as sample_scatter, etc... and create the data state.
- table_index_model = self._table_model.get_table_entry(row)
if file_lookup:
- file_information = table_index_model.file_information
+ file_information = row_entry.file_information
else:
file_information = SANSFileInformationBlank()
- data_builder = get_data_builder(self._facility, file_information, user_file)
-
- self._set_data_entry(data_builder.set_sample_scatter, table_index_model.sample_scatter)
- self._set_data_period_entry(data_builder.set_sample_scatter_period, table_index_model.sample_scatter_period)
- self._set_data_entry(data_builder.set_sample_transmission, table_index_model.sample_transmission)
- self._set_data_period_entry(data_builder.set_sample_transmission_period, table_index_model.sample_transmission_period) # noqa
- self._set_data_entry(data_builder.set_sample_direct, table_index_model.sample_direct)
- self._set_data_period_entry(data_builder.set_sample_direct_period, table_index_model.sample_direct_period)
- self._set_data_entry(data_builder.set_can_scatter, table_index_model.can_scatter)
- self._set_data_period_entry(data_builder.set_can_scatter_period, table_index_model.can_scatter_period)
- self._set_data_entry(data_builder.set_can_transmission, table_index_model.can_transmission)
- self._set_data_period_entry(data_builder.set_can_transmission_period, table_index_model.can_transmission_period)
- self._set_data_entry(data_builder.set_can_direct, table_index_model.can_direct)
- self._set_data_period_entry(data_builder.set_can_direct_period, table_index_model.can_direct_period)
+ data_builder = get_data_builder(self._facility, file_information)
+
+ self._set_data_entry(data_builder.set_sample_scatter, row_entry.sample_scatter)
+ self._set_data_period_entry(data_builder.set_sample_scatter_period, row_entry.sample_scatter_period)
+ self._set_data_entry(data_builder.set_sample_transmission, row_entry.sample_transmission)
+ self._set_data_period_entry(data_builder.set_sample_transmission_period, row_entry.sample_transmission_period) # noqa
+ self._set_data_entry(data_builder.set_sample_direct, row_entry.sample_direct)
+ self._set_data_period_entry(data_builder.set_sample_direct_period, row_entry.sample_direct_period)
+ self._set_data_entry(data_builder.set_can_scatter, row_entry.can_scatter)
+ self._set_data_period_entry(data_builder.set_can_scatter_period, row_entry.can_scatter_period)
+ self._set_data_entry(data_builder.set_can_transmission, row_entry.can_transmission)
+ self._set_data_period_entry(data_builder.set_can_transmission_period, row_entry.can_transmission_period)
+ self._set_data_entry(data_builder.set_can_direct, row_entry.can_direct)
+ self._set_data_period_entry(data_builder.set_can_direct_period, row_entry.can_direct_period)
data = data_builder.build()
# 2. Add elements from the options column
state_gui_model = copy.deepcopy(self._state_gui_model)
- options_column_model = table_index_model.options_column_model
- self._apply_column_options_to_state(options_column_model, state_gui_model)
+ self._apply_column_options_to_state(row_entry, state_gui_model)
# 3. Add other columns
- output_name = table_index_model.output_name
+ output_name = row_entry.output_name
if output_name:
state_gui_model.output_name = output_name
- if table_index_model.sample_thickness:
- state_gui_model.sample_thickness = float(table_index_model.sample_thickness)
- if table_index_model.sample_height:
- state_gui_model.sample_height = float(table_index_model.sample_height)
- if table_index_model.sample_width:
- state_gui_model.sample_width = float(table_index_model.sample_width)
- if table_index_model.sample_shape:
- state_gui_model.sample_shape = table_index_model.sample_shape
+ if row_entry.sample_thickness:
+ state_gui_model.sample_thickness = float(row_entry.sample_thickness)
+ if row_entry.sample_height:
+ state_gui_model.sample_height = float(row_entry.sample_height)
+ if row_entry.sample_width:
+ state_gui_model.sample_width = float(row_entry.sample_width)
+ if row_entry.sample_shape:
+ state_gui_model.sample_shape = row_entry.sample_shape
# 4. Create the rest of the state based on the builder.
- user_file_state_director = StateDirectorISIS(data, file_information)
settings = copy.deepcopy(state_gui_model.settings)
- user_file_state_director.add_state_settings(settings)
+ command_interface = CommandInterfaceAdapter(data_info=data, processed_state=settings)
+ run_data_builder = StateRunDataBuilder(file_information=file_information)
- return user_file_state_director.construct()
+ state = StateBuilder(run_data_builder=run_data_builder, i_state_parser=command_interface).get_all_states()
+ return state
@staticmethod
def _set_data_entry(func, entry):
@@ -98,7 +96,7 @@ class GuiStateDirector(object):
pass
@staticmethod
- def _apply_column_options_to_state(options_column_model, state_gui_model):
+ def _apply_column_options_to_state(table_index_model, state_gui_model):
"""
Apply the column setting of the user to the state for that particular row.
@@ -106,7 +104,7 @@ class GuiStateDirector(object):
:param options_column_model: the option column model with the row specific settings
:param state_gui_model: the state gui model
"""
- options = options_column_model.get_options()
+ options = table_index_model.options.get_options_dict()
# Here we apply the correction to the state depending on the settings in the options. This is not very nice,
# but currently it is not clear how to solve this differently.
diff --git a/scripts/SANS/sans/gui_logic/presenter/masking_table_presenter.py b/scripts/SANS/sans/gui_logic/presenter/masking_table_presenter.py
index 69f1620ed6d08319adfc1f88e01d5e94abc8f05e..9c2ac95ca87e25d654e1ffd7e8a32fc99c1519a4 100644
--- a/scripts/SANS/sans/gui_logic/presenter/masking_table_presenter.py
+++ b/scripts/SANS/sans/gui_logic/presenter/masking_table_presenter.py
@@ -122,7 +122,7 @@ class MaskingTablePresenter(object):
self._presenter = presenter
def on_row_changed(self):
- self._presenter.on_row_changed()
+ pass
def on_update_rows(self):
self._presenter.on_update_rows()
@@ -147,12 +147,6 @@ class MaskingTablePresenter(object):
self._work_handler = WorkHandler()
self._logger = Logger("SANS")
- def on_row_changed(self):
- row_index = self._view.get_current_row()
- state = self.get_state(row_index, file_lookup=False, suppress_warnings=True)
- if state:
- self.display_masking_information(state)
-
def on_display(self):
# Get the state information for the selected row.
# Disable the button
@@ -163,17 +157,19 @@ class MaskingTablePresenter(object):
state = self.get_state(row_index)
except Exception as e:
self.on_processing_error_masking_display(e)
- raise Exception(str(e)) # propagate errors for run_tab_presenter to deal with
- else:
- if not state:
- self._logger.information("You can only show a masked workspace if a user file has been loaded and there"
- "valid sample scatter entry has been provided in the selected row.")
- return
-
- # Run the task
- listener = MaskingTablePresenter.DisplayMaskListener(self)
- state_copy = copy.copy(state)
- self._work_handler.process(listener, load_and_mask_workspace, 0, state_copy, self.DISPLAY_WORKSPACE_NAME)
+ raise e # propagate errors for run_tab_presenter to deal with
+
+ if not state:
+ self._logger.error("You can only show a masked workspace if a user file has been loaded and there"
+ "valid sample scatter entry has been provided in the selected row.")
+ self._view.set_display_mask_button_to_normal()
+ return
+
+ # Run the task
+ self.display_masking_information(state)
+ listener = MaskingTablePresenter.DisplayMaskListener(self)
+ state_copy = copy.copy(state)
+ self._work_handler.process(listener, load_and_mask_workspace, 0, state_copy, self.DISPLAY_WORKSPACE_NAME)
def on_processing_finished_masking_display(self, result):
# Enable button
@@ -207,7 +203,6 @@ class MaskingTablePresenter(object):
if new_row_index != -1:
self.set_row(new_row_index)
- self.on_row_changed()
def set_row(self, index):
self._view.set_row(index)
diff --git a/scripts/SANS/sans/gui_logic/presenter/run_tab_presenter.py b/scripts/SANS/sans/gui_logic/presenter/run_tab_presenter.py
index 481341efc07086215b5b4ff9468c008602a7fb1b..5416c83893ef7c2b5f083c05df8de4a40bb9a315 100644
--- a/scripts/SANS/sans/gui_logic/presenter/run_tab_presenter.py
+++ b/scripts/SANS/sans/gui_logic/presenter/run_tab_presenter.py
@@ -13,36 +13,35 @@ for presenting and generating the reduction settings.
from __future__ import (absolute_import, division, print_function)
import copy
-import csv
import os
import time
import traceback
+from contextlib import contextmanager
+
from qtpy import PYQT4
from mantid.api import (FileFinder)
from mantid.kernel import Logger, ConfigService, ConfigPropertyObserver
-from mantid.py3compat import csv_open_type
-from sans.command_interface.batch_csv_file_parser import BatchCsvParser
-from sans.common.constants import ALL_PERIODS
-from sans.common.enums import (BatchReductionEntry, ReductionMode, RangeStepType, RowState, SampleShape,
+from sans.command_interface.batch_csv_parser import BatchCsvParser
+from sans.common.enums import (ReductionMode, RangeStepType, RowState, SampleShape,
SaveType, SANSInstrument)
from sans.gui_logic.gui_common import (add_dir_to_datasearch, get_reduction_mode_from_gui_selection,
get_reduction_mode_strings_for_gui, get_string_for_gui_from_instrument,
- remove_dir_from_datasearch, SANSGuiPropertiesHandler)
+ SANSGuiPropertiesHandler)
+from sans.gui_logic.models.RowEntries import RowEntries
from sans.gui_logic.models.batch_process_runner import BatchProcessRunner
-from sans.gui_logic.models.beam_centre_model import BeamCentreModel
from sans.gui_logic.models.create_state import create_states
from sans.gui_logic.models.diagnostics_page_model import run_integral, create_state
from sans.gui_logic.models.settings_adjustment_model import SettingsAdjustmentModel
from sans.gui_logic.models.state_gui_model import StateGuiModel
-from sans.gui_logic.models.table_model import TableModel, TableIndexModel
+from sans.gui_logic.models.table_model import TableModel
from sans.gui_logic.presenter.beam_centre_presenter import BeamCentrePresenter
from sans.gui_logic.presenter.diagnostic_presenter import DiagnosticsPagePresenter
-from sans.gui_logic.presenter.masking_table_presenter import (MaskingTablePresenter)
+from sans.gui_logic.presenter.masking_table_presenter import MaskingTablePresenter
from sans.gui_logic.presenter.presenter_common import PresenterCommon
from sans.gui_logic.presenter.save_other_presenter import SaveOtherPresenter
from sans.gui_logic.presenter.settings_adjustment_presenter import SettingsAdjustmentPresenter
-from sans.gui_logic.presenter.settings_diagnostic_presenter import (SettingsDiagnosticPresenter)
+from sans.gui_logic.presenter.settings_diagnostic_presenter import SettingsDiagnosticPresenter
from sans.sans_batch import SANSCentreFinder
from sans.user_file.user_file_reader import UserFileReader
from ui.sans_isis import SANSSaveOtherWindow
@@ -57,7 +56,7 @@ if PYQT4:
except ImportError:
pass
else:
- from mantidqt.plotting.functions import get_plot_fig
+ from mantid.plots.plotfunctions import get_plot_fig
row_state_to_colour_mapping = {RowState.UNPROCESSED: '#FFFFFF', RowState.PROCESSED: '#d0f4d0',
RowState.ERROR: '#accbff'}
@@ -129,8 +128,8 @@ class RunTabPresenter(PresenterCommon):
def on_output_mode_changed(self):
self._presenter.on_output_mode_changed()
- def on_data_changed(self, row, column, new_value, old_value):
- self._presenter.on_data_changed(row, column, new_value, old_value)
+ def on_data_changed(self, index, row):
+ self._presenter.on_data_changed(index, row)
def on_manage_directories(self):
self._presenter.on_manage_directories()
@@ -138,8 +137,8 @@ class RunTabPresenter(PresenterCommon):
def on_instrument_changed(self):
self._presenter.on_instrument_changed()
- def on_row_inserted(self, index, row):
- self._presenter.on_row_inserted(index, row)
+ def on_row_inserted(self):
+ self._presenter.on_row_appended()
def on_rows_removed(self, rows):
self._presenter.on_rows_removed(rows)
@@ -176,7 +175,7 @@ class RunTabPresenter(PresenterCommon):
def on_processing_error(self, error):
self._presenter.on_processing_error(error)
- def __init__(self, facility, view=None):
+ def __init__(self, facility, model=None, table_model=None, view=None, ):
# We don't have access to state model really at this point
super(RunTabPresenter, self).__init__(view, None)
@@ -190,16 +189,11 @@ class RunTabPresenter(PresenterCommon):
self.progress = 0
# Models that are being used by the presenter
- self._table_model = TableModel()
+ self._model = model if model else StateGuiModel(user_file_items={})
+ self._table_model = table_model if table_model else TableModel()
self._table_model.subscribe_to_model_changes(self)
- # Any child presenters
- self._setup_sub_presenters()
-
- # Presenter needs to have a handle on the view since it delegates it
- self.set_view(view)
self._processing = False
- self.work_handler = WorkHandler()
self.batch_process_runner = BatchProcessRunner(self.notify_progress,
self.on_processing_finished,
self.on_processing_error)
@@ -208,6 +202,13 @@ class RunTabPresenter(PresenterCommon):
self._file_information = None
self._clipboard = []
+ self._csv_parser = BatchCsvParser()
+
+ self._setup_sub_presenters()
+
+ # Presenter needs to have a handle on the view since it delegates it
+ self.set_view(view)
+
# Check save dir for display
self._save_directory_observer = \
SaveDirectoryObserver(self._handle_output_directory_changed)
@@ -226,8 +227,7 @@ class RunTabPresenter(PresenterCommon):
self._table_model.subscribe_to_model_changes(self._masking_table_presenter)
# Beam centre presenter
- self._beam_centre_presenter = BeamCentrePresenter(self, WorkHandler, BeamCentreModel,
- SANSCentreFinder)
+ self._beam_centre_presenter = BeamCentrePresenter(self, SANSCentreFinder)
self._table_model.subscribe_to_model_changes(self._beam_centre_presenter)
# Workspace Diagnostic page presenter
@@ -342,6 +342,18 @@ class RunTabPresenter(PresenterCommon):
if self._view.get_user_file_path() == '':
self._view.gui_properties_handler.set_setting("user_file", '')
+ @property
+ def instrument(self):
+ return self._model.instrument
+
+ @contextmanager
+ def disable_buttons(self):
+ self._view.disable_buttons()
+ try:
+ yield
+ finally:
+ self._view.enable_buttons()
+
def on_user_file_load(self):
"""
Loads the user file. Populates the models and the view.
@@ -412,17 +424,17 @@ class RunTabPresenter(PresenterCommon):
"""
Loads a batch file and populates the batch table based on that.
"""
- try:
- # 1. Get the batch file from the view
- batch_file_path = self._view.get_batch_file_path()
+ # 1. Get the batch file from the view
+ batch_file_path = self._view.get_batch_file_path()
- if not batch_file_path:
- return
+ if not batch_file_path:
+ return
- datasearch_dirs = ConfigService["datasearch.directories"]
- batch_file_directory, datasearch_dirs = add_dir_to_datasearch(batch_file_path, datasearch_dirs)
- ConfigService["datasearch.directories"] = datasearch_dirs
+ datasearch_dirs = ConfigService["datasearch.directories"]
+ batch_file_directory, datasearch_dirs = add_dir_to_datasearch(batch_file_path, datasearch_dirs)
+ ConfigService["datasearch.directories"] = datasearch_dirs
+ try:
if not os.path.exists(batch_file_path):
raise RuntimeError(
"The batch file path {} does not exist. Make sure a valid batch file path"
@@ -431,88 +443,18 @@ class RunTabPresenter(PresenterCommon):
self._table_model.batch_file = batch_file_path
# 2. Read the batch file
- batch_file_parser = BatchCsvParser(batch_file_path)
- parsed_rows = batch_file_parser.parse_batch_file()
+ parsed_rows = self._csv_parser.parse_batch_file(batch_file_path)
# 3. Populate the table
self._table_model.clear_table_entries()
self._add_multiple_rows_to_table_model(rows=parsed_rows)
- self._table_model.remove_table_entries([len(parsed_rows)])
except RuntimeError as e:
- if batch_file_directory:
- # Remove added directory from datasearch.directories
- ConfigService["datasearch.directories"] = remove_dir_from_datasearch(batch_file_directory, datasearch_dirs)
-
self.sans_logger.error("Loading of the batch file failed. {}".format(str(e)))
self.display_warning_box('Warning', 'Loading of the batch file failed', str(e))
def _add_multiple_rows_to_table_model(self, rows):
- parsed_rows = []
- for row in rows:
- parsed_rows.append(self._parse_row_for_table_model(row=row))
-
- self._table_model.add_multiple_table_entries(table_index_model_list=parsed_rows)
-
- @staticmethod
- def _parse_row_for_table_model(row):
- def get_string_entry(_tag, _row):
- _element = ""
- if _tag in _row:
- _element = _row[_tag]
- return _element
-
- def get_string_period(_tag):
- return "" if _tag == ALL_PERIODS else str(_tag)
-
- # ----Pull out the entries----
- # Run numbers
- sample_scatter = get_string_entry(BatchReductionEntry.SAMPLE_SCATTER, row)
- sample_scatter_period = get_string_period(
- get_string_entry(BatchReductionEntry.SAMPLE_SCATTER_PERIOD, row))
- sample_transmission = get_string_entry(BatchReductionEntry.SAMPLE_TRANSMISSION, row)
- sample_transmission_period = \
- get_string_period(get_string_entry(BatchReductionEntry.SAMPLE_TRANSMISSION_PERIOD, row))
- sample_direct = get_string_entry(BatchReductionEntry.SAMPLE_DIRECT, row)
- sample_direct_period = get_string_period(
- get_string_entry(BatchReductionEntry.SAMPLE_DIRECT_PERIOD, row))
- can_scatter = get_string_entry(BatchReductionEntry.CAN_SCATTER, row)
- can_scatter_period = get_string_period(
- get_string_entry(BatchReductionEntry.CAN_SCATTER_PERIOD, row))
- can_transmission = get_string_entry(BatchReductionEntry.CAN_TRANSMISSION, row)
- can_transmission_period = get_string_period(
- get_string_entry(BatchReductionEntry.CAN_SCATTER_PERIOD, row))
- can_direct = get_string_entry(BatchReductionEntry.CAN_DIRECT, row)
- can_direct_period = get_string_period(
- get_string_entry(BatchReductionEntry.CAN_DIRECT_PERIOD, row))
-
- # Other information
- output_name = get_string_entry(BatchReductionEntry.OUTPUT, row)
- user_file = get_string_entry(BatchReductionEntry.USER_FILE, row)
-
- # Sample geometries
- sample_thickness = get_string_entry(BatchReductionEntry.SAMPLE_THICKNESS, row)
- sample_height = get_string_entry(BatchReductionEntry.SAMPLE_HEIGHT, row)
- sample_width = get_string_entry(BatchReductionEntry.SAMPLE_WIDTH, row)
-
- # ----Form a row----
- row_entry = [sample_scatter, sample_scatter_period, sample_transmission,
- sample_transmission_period,
- sample_direct, sample_direct_period, can_scatter, can_scatter_period,
- can_transmission, can_transmission_period,
- can_direct, can_direct_period,
- output_name, user_file,
- sample_thickness, sample_height, sample_width]
-
- table_index_model = TableIndexModel(*row_entry)
- return table_index_model
-
- def _add_row_to_table_model(self, row, index):
- """
- Adds a row to the table
- """
- table_index_model = self._parse_row_for_table_model(row=row)
- self._table_model.add_table_entry(index, table_index_model)
+ self._table_model.add_multiple_table_entries(table_index_model_list=rows)
def on_update_rows(self):
self.update_view_from_table_model()
@@ -521,22 +463,26 @@ class RunTabPresenter(PresenterCommon):
self._view.clear_table()
self._view.hide_period_columns()
- for row_index, row in enumerate(self._table_model._table_entries):
- row_entry = [str(x) for x in row.to_list()]
- self._view.add_row(row_entry)
- self._view.change_row_color(row_state_to_colour_mapping[row.row_state], row_index + 1)
+ num_rows = self._table_model.get_number_of_rows()
+ for row_index in range(num_rows):
+ row = self._table_model.get_row(row_index)
+ self._view.add_row(row)
+ self._view.change_row_color(row_state_to_colour_mapping[row.state], row_index + 1)
self._view.set_row_tooltip(row.tool_tip, row_index + 1)
- if row.isMultiPeriod():
+ if row.is_multi_period():
self._view.show_period_columns()
self._view.remove_rows([0])
self._view.clear_selection()
- def on_data_changed(self, row, column, new_value, old_value):
- self._table_model.update_table_entry(row, column, new_value)
- self._view.change_row_color(row_state_to_colour_mapping[RowState.UNPROCESSED], row)
- self._view.set_row_tooltip('', row)
+ def on_data_changed(self, index, row_entries):
+ # TODO this is inefficient, but we should only be parsing the user input
+ # when they hit a button, not as they type
+ self._table_model.replace_table_entry(index, row_entries)
+ self._view.change_row_color(row_state_to_colour_mapping[RowState.UNPROCESSED], index)
+ self._view.set_row_tooltip('', index)
self._beam_centre_presenter.on_update_rows()
self._masking_table_presenter.on_update_rows()
+ self.update_view_from_table_model()
def on_instrument_changed(self):
self._setup_instrument_specific_settings()
@@ -574,15 +520,18 @@ class RunTabPresenter(PresenterCommon):
"""
Processes a list of rows. Any errors cause the row to be coloured red.
"""
-
self._set_progress_bar(current=0, number_steps=len(rows))
try:
# Trip up early if output modes are invalid
self._validate_output_modes()
+ row_index_pair = []
+
for row in rows:
- self._table_model.reset_row_state(row)
+ row.reset_row_state()
+ row_index_pair.append((row, self._table_model.get_row_index(row)))
+
self.update_view_from_table_model()
self._view.disable_buttons()
@@ -595,8 +544,7 @@ class RunTabPresenter(PresenterCommon):
# MantidPlot and Workbench have different approaches to plotting
output_graph = self.output_graph if PYQT4 else self.output_fig
- self.batch_process_runner.process_states(rows, self.get_states,
- self._table_model.get_thickness_for_rows,
+ self.batch_process_runner.process_states(row_index_pair, self.get_states,
self._view.use_optimizations,
self._view.output_mode,
self._view.plot_results,
@@ -604,7 +552,7 @@ class RunTabPresenter(PresenterCommon):
save_can)
except Exception as e:
- self.on_processing_finished(None)
+ self.on_processing_finished()
self.sans_logger.error("Process halted due to: {}".format(str(e)))
self.display_warning_box('Warning', 'Process halted', str(e))
@@ -632,8 +580,8 @@ class RunTabPresenter(PresenterCommon):
we want to raise an error here. (If we don't, an error will be raised on attempting
to save after performing the reductions)
"""
- if (self._view.output_mode_file_radio_button.isChecked() or
- self._view.output_mode_both_radio_button.isChecked()):
+ if (self._view.output_mode_file_radio_button.isChecked()
+ or self._view.output_mode_both_radio_button.isChecked()):
if self._view.save_types == [SaveType.NO_TYPE]:
raise RuntimeError("You have selected an output mode which saves to file, "
"but no file types have been selected.")
@@ -656,48 +604,62 @@ class RunTabPresenter(PresenterCommon):
"""
Process all entries in the table, regardless of selection.
"""
- all_rows = range(self._table_model.get_number_of_rows())
- all_rows = self._table_model.get_non_empty_rows(all_rows)
- if all_rows:
- self._process_rows(all_rows)
+ to_process = self._table_model.get_non_empty_rows()
+ if to_process:
+ self._process_rows(to_process)
+
+ def _get_selected_non_empty_rows(self):
+ selected_rows = self._view.get_selected_rows()
+ to_process = [self._table_model.get_row(i) for i in selected_rows]
+ return [row for row in to_process if not row.is_empty()]
def on_process_selected_clicked(self):
"""
Process selected table entries.
"""
- selected_rows = self._view.get_selected_rows()
- selected_rows = self._table_model.get_non_empty_rows(selected_rows)
- if selected_rows:
- self._process_rows(selected_rows)
+ to_process = self._get_selected_non_empty_rows()
- def on_processing_error(self, row, error_msg):
+ if to_process:
+ self._process_rows(to_process)
+
+ def on_processing_error(self, row_index, error_msg):
"""
An error occurs while processing the row with index row, error_msg is displayed as a
tooltip on the row.
"""
self.increment_progress()
- self._table_model.set_row_to_error(row, error_msg)
+ row = self._table_model.get_row(row_index)
+ row.state = RowState.ERROR
+ row.tool_tip = error_msg
self.update_view_from_table_model()
def on_processing_finished(self, result):
self._view.enable_buttons()
self._processing = False
+ self.update_view_from_table_model()
def on_load_clicked(self):
+ selected_rows = self._get_selected_non_empty_rows()
+ if len(selected_rows) == 0:
+ # Try to process all rows
+ selected_rows = self._table_model.get_non_empty_rows()
+
+ if len(selected_rows) == 0:
+ return
+
self._view.disable_buttons()
self._processing = True
self.sans_logger.information("Starting load of batch table.")
- selected_rows = self._get_selected_rows()
+ row_index_pair = []
for row in selected_rows:
- self._table_model.reset_row_state(row)
+ row.reset_row_state()
+ row_index_pair.append((row, self._table_model.get_row_index(row)))
self._set_progress_bar(current=0, number_steps=len(selected_rows))
- selected_rows = self._table_model.get_non_empty_rows(selected_rows)
try:
- self.batch_process_runner.load_workspaces(selected_rows=selected_rows, get_states_func=self.get_states,
- get_thickness_for_rows_func=self._table_model.get_thickness_for_rows)
+ self.batch_process_runner.load_workspaces(row_index_pair=row_index_pair, get_states_func=self.get_states)
except Exception as e:
self._view.enable_buttons()
self.sans_logger.error("Process halted due to: {}".format(str(e)))
@@ -719,30 +681,20 @@ class RunTabPresenter(PresenterCommon):
return filename
def on_export_table_clicked(self):
- non_empty_rows = self.get_row_indices()
+ non_empty_rows = self._table_model.get_non_empty_rows()
if len(non_empty_rows) == 0:
- self.sans_logger.notice("Cannot export table as it is empty.")
+ self.sans_logger.warning("Cannot export table as it is empty.")
return
- try:
- self._view.disable_buttons()
-
+ with self.disable_buttons():
default_filename = self._table_model.batch_file
filename = self.display_save_file_box("Save table as", default_filename, "*.csv")
filename = self._get_filename_to_save(filename)
- if filename is not None:
- self.sans_logger.information("Starting export of table. Filename: {}".format(filename))
- with open(filename, csv_open_type) as outfile:
- # Pass filewriting object rather than filename to make testing easier
- writer = csv.writer(outfile)
- self._export_table(writer, non_empty_rows)
- self.sans_logger.information("Table exporting finished.")
- self._view.enable_buttons()
- except Exception as e:
- self._view.enable_buttons()
- self.sans_logger.error("Export halted due to : {}".format(str(e)))
- self.display_warning_box("Warning", "Export halted", str(e))
+ if filename:
+ self.sans_logger.information("Starting export of table. Filename: {}".format(filename))
+ self._csv_parser.save_batch_file(rows=non_empty_rows, file_path=filename)
+ self.sans_logger.information("Table exporting finished.")
def on_multiperiod_changed(self, show_periods):
if show_periods:
@@ -773,16 +725,21 @@ class RunTabPresenter(PresenterCommon):
filename = self._view.display_save_file_box(title, default_path, file_filter)
return filename
- def notify_progress(self, row, out_shift_factors, out_scale_factors):
- self.increment_progress()
+ def notify_progress(self, row_index, out_shift_factors, out_scale_factors):
+ self.progress += 1
+ setattr(self._view, 'progress_bar_value', self.progress)
+
+ row_entry = self._table_model.get_row(row_index)
+
if out_scale_factors and out_shift_factors:
- self._table_model.set_option(row, 'MergeScale', round(out_scale_factors[0], 3))
- self._table_model.set_option(row, 'MergeShift', round(out_shift_factors[0], 3))
+ row_entry.options.set_developer_option('MergeScale', round(out_scale_factors[0], 3))
+ row_entry.options.set_developer_option('MergeShift', round(out_shift_factors[0], 3))
- self._table_model.set_row_to_processed(row, '')
+ row_entry.state = RowState.PROCESSED
+ row_entry.tool_tip = None
def increment_progress(self):
- self.progress = self.progress + 1
+ self.progress += 1
setattr(self._view, 'progress_bar_value', self.progress)
# ----------------------------------------------------------------------------------------------
@@ -792,12 +749,12 @@ class RunTabPresenter(PresenterCommon):
def num_rows(self):
return self._table_model.get_number_of_rows()
- def on_row_inserted(self, index, row):
+ def on_row_appended(self):
"""
Insert a row at a selected point
"""
- row_table_index = TableIndexModel(*row)
- self._table_model.add_table_entry(index, row_table_index)
+ self._table_model.append_table_entry(RowEntries())
+ self.update_view_from_table_model()
def on_insert_row(self):
"""
@@ -806,47 +763,55 @@ class RunTabPresenter(PresenterCommon):
"""
selected_rows = self._view.get_selected_rows()
- selected_row = selected_rows[0] + 1 if selected_rows else self.num_rows()
- empty_row = self._table_model.create_empty_row()
- self._table_model.add_table_entry(selected_row, empty_row)
+ empty_row = RowEntries()
+ if len(selected_rows) >= 1 :
+ self._table_model.insert_row_at(row_index=selected_rows[0] + 1, row_entry=empty_row)
+ else:
+ self._table_model.append_table_entry(empty_row)
+
+ self.update_view_from_table_model()
def on_erase_rows(self):
"""
Make all selected rows empty.
"""
selected_rows = self._view.get_selected_rows()
- if len(selected_rows) == 1 and self._table_model.get_number_of_rows() == 1:
- self._table_model.replace_table_entries(selected_rows, [])
+ if not selected_rows or len(selected_rows) == self._table_model.get_number_of_rows():
+ self._table_model.clear_table_entries()
else:
for row in selected_rows:
- empty_row = self._table_model.create_empty_row()
+ empty_row = RowEntries()
self._table_model.replace_table_entries([row], [empty_row])
+ self.update_view_from_table_model()
- def on_rows_removed(self, rows):
+ def on_rows_removed(self, row_indices):
"""
Remove rows from the table
"""
- self._table_model.remove_table_entries(rows)
+ self._table_model.remove_table_entries(row_indices)
+ self.update_view_from_table_model()
def on_copy_rows_requested(self):
selected_rows = self._view.get_selected_rows()
self._clipboard = []
for row in selected_rows:
- data_from_table_model = self._table_model.get_table_entry(row).to_list()
+ data_from_table_model = self._table_model.get_row(row)
self._clipboard.append(data_from_table_model)
def on_cut_rows_requested(self):
self.on_copy_rows_requested()
- rows = self._view.get_selected_rows()
- self.on_rows_removed(rows)
+ row_indices = self._view.get_selected_rows()
+ self.on_rows_removed(row_indices)
def on_paste_rows_requested(self):
if self._clipboard:
selected_rows = self._view.get_selected_rows()
selected_rows = selected_rows if selected_rows else [self.num_rows()]
- replacement_table_index_models = [TableIndexModel(*x) for x in self._clipboard]
+ replacement_table_index_models = self._clipboard
self._table_model.replace_table_entries(selected_rows, replacement_table_index_models)
+ self.update_view_from_table_model()
+
def on_manage_directories(self):
self._view.show_directory_manager()
@@ -862,10 +827,10 @@ class RunTabPresenter(PresenterCommon):
:return: a list of row indices.
"""
row_indices_which_are_not_empty = []
- number_of_rows = self._table_model.get_number_of_rows()
- for row in range(number_of_rows):
- if not self.is_empty_row(row):
- row_indices_which_are_not_empty.append(row)
+ rows = self._table_model.get_all_rows()
+ for i, row in enumerate(rows):
+ if not row.is_empty():
+ row_indices_which_are_not_empty.append(i)
return row_indices_which_are_not_empty
def on_mask_file_add(self):
@@ -890,14 +855,6 @@ class RunTabPresenter(PresenterCommon):
self._settings_diagnostic_tab_presenter.on_update_rows()
self._beam_centre_presenter.on_update_rows()
- def is_empty_row(self, row):
- """
- Checks if a row has no entries. These rows will be ignored.
- :param row: the row index
- :return: True if the row is empty.
- """
- return self._table_model.is_empty_row(row)
-
def on_save_other(self):
self.save_other_presenter = SaveOtherPresenter(parent_presenter=self)
save_other_view = SANSSaveOtherWindow.SANSSaveOtherDialog(self._view)
@@ -941,10 +898,10 @@ class RunTabPresenter(PresenterCommon):
return selected_rows
@log_times
- def get_states(self, row_index=None, file_lookup=True, suppress_warnings=False):
+ def get_states(self, row_entries=None, file_lookup=True, suppress_warnings=False):
"""
Gathers the state information for all rows.
- :param row_index: if a single row is selected, then only this row is returned,
+ :param row_entries: if a single row is selected, then only this row is returned,
else all the state for all rows is returned.
:param suppress_warnings: bool. If true don't propagate errors.
This variable is introduced to stop repeated errors
@@ -961,10 +918,9 @@ class RunTabPresenter(PresenterCommon):
# 3. Go through each row and construct a state object
states, errors = None, None
if table_model and state_model_with_view_update:
- states, errors = create_states(state_model_with_view_update, table_model,
- self._view.instrument,
- self._facility,
- row_index=row_index,
+ states, errors = create_states(state_model_with_view_update,
+ facility=self._facility,
+ row_entries=row_entries,
file_lookup=file_lookup,
user_file=self._view.get_user_file_path())
@@ -975,6 +931,9 @@ class RunTabPresenter(PresenterCommon):
return states, errors
+ def get_row(self, row_index):
+ return self._table_model.get_row(index=row_index)
+
def get_state_for_row(self, row_index, file_lookup=True, suppress_warnings=False):
"""
Creates the state for a particular row.
@@ -985,7 +944,8 @@ class RunTabPresenter(PresenterCommon):
SANS calls get_states.
:return: a state if the index is valid and there is a state else None
"""
- states, errors = self.get_states(row_index=[row_index], file_lookup=file_lookup,
+ row_entry = self._table_model.get_row(row_index)
+ states, errors = self.get_states(row_entries=[row_entry], file_lookup=file_lookup,
suppress_warnings=suppress_warnings)
if states is None:
if not suppress_warnings:
@@ -993,10 +953,7 @@ class RunTabPresenter(PresenterCommon):
"There does not seem to be data for a row {}.".format(row_index))
return None
- if row_index in states:
- if states:
- return states[row_index]
- return None
+ return states[row_entry]
def update_view_from_model(self):
self._set_on_view("instrument")
@@ -1192,42 +1149,6 @@ class RunTabPresenter(PresenterCommon):
q_1d_rebin_string += str(q_1d_max)
state_model.q_1d_rebin_string = q_1d_rebin_string
- def get_cell_value(self, row, column):
- return self._view.get_cell(row=row, column=self.table_index[column], convert_to=str)
-
- def _export_table(self, filewriter, rows):
- """
- Take the current table model, and create a comma delimited csv file
- :param filewriter: File object to be written to
- :type filewrite: csv.writer object
- :param rows: list of indices for non-empty rows
- :type rows: list of ints
- """
- for row in rows:
- table_row = self._table_model.get_table_entry(row).to_batch_list()
- batch_file_row = self._create_batch_entry_from_row(table_row)
- filewriter.writerow(batch_file_row)
-
- @staticmethod
- def _create_batch_entry_from_row(row):
- batch_file_keywords = ["sample_sans",
- "sample_trans",
- "sample_direct_beam",
- "can_sans",
- "can_trans",
- "can_direct_beam",
- "output_as",
- "user_file",
- "sample_thickness",
- "sample_height",
- "sample_width"]
- new_row = []
- for key, value in zip(batch_file_keywords, row):
- new_row.append(key)
- new_row.append(value)
-
- return new_row
-
# ------------------------------------------------------------------------------------------------------------------
# Settings
# ------------------------------------------------------------------------------------------------------------------
diff --git a/scripts/SANS/sans/sans_batch.py b/scripts/SANS/sans/sans_batch.py
index e8cee1b8e5d83cd7c933e6fa1745b264c7505cad..26d5b28874c4d88a374e1c586b8fae6a96603459 100644
--- a/scripts/SANS/sans/sans_batch.py
+++ b/scripts/SANS/sans/sans_batch.py
@@ -7,7 +7,7 @@
# pylint: disable=invalid-name
""" SANBatchReduction algorithm is the starting point for any new type reduction, event single reduction"""
from __future__ import (absolute_import, division, print_function)
-from sans.state.state import State
+from sans.state.AllStates import AllStates
from sans.algorithm_detail.batch_execution import (single_reduction_for_batch)
from sans.common.enums import (OutputMode, FindDirectionEnum, DetectorType)
from sans.algorithm_detail.centre_finder_new import centre_finder_new, centre_finder_mass
@@ -55,7 +55,7 @@ class SANSBatchReduction(object):
raise RuntimeError("The provided states are not in a list. They have to be in a list.")
for state in states:
- if not isinstance(state, State):
+ if not isinstance(state, AllStates):
raise RuntimeError("The entries have to be sans state objects. "
"The provided type is {0}".format(type(state)))
@@ -138,7 +138,7 @@ class SANSCentreFinder(object):
# 3. xstart, ystart have to be floats
# 4. max_iter has to be an integer
- if not isinstance(state, State):
+ if not isinstance(state, AllStates):
raise RuntimeError("The entries have to be sans state objects. "
"The provided type is {0}".format(type(state)))
diff --git a/scripts/SANS/sans/state/state.py b/scripts/SANS/sans/state/AllStates.py
similarity index 90%
rename from scripts/SANS/sans/state/state.py
rename to scripts/SANS/sans/state/AllStates.py
index 68448e4b5f6286c83cbdb6186a5c4c4e94381855..98155f95baa24697a2bf26f943e8f656f5137b9e 100644
--- a/scripts/SANS/sans/state/state.py
+++ b/scripts/SANS/sans/state/AllStates.py
@@ -14,21 +14,21 @@ from six import with_metaclass
from sans.common.enums import SANSFacility
from sans.state.JsonSerializable import JsonSerializable
+from sans.state.StateObjects.StateCompatibility import get_compatibility_builder
# Note that the compatibility state is not part of the new reduction chain, but allows us to accurately compare
# results obtained via the old and new reduction chain
from sans.state.automatic_setters import automatic_setters
-from sans.state.compatibility import get_compatibility_builder
# ----------------------------------------------------------------------------------------------------------------------
# State
# ----------------------------------------------------------------------------------------------------------------------
-class State(with_metaclass(JsonSerializable)):
+class AllStates(with_metaclass(JsonSerializable)):
def __init__(self):
- super(State, self).__init__()
+ super(AllStates, self).__init__()
self.data = None # : StateData
self.move = None # : StateMove
self.reduction = None # : StateReductionMode
@@ -75,11 +75,11 @@ class State(with_metaclass(JsonSerializable)):
raise ValueError("State: There is an issue with your input. See: {0}".format(json.dumps(is_invalid)))
-class StateBuilder(object):
- @automatic_setters(State)
+class AllStatesBuilder(object):
+ @automatic_setters(AllStates)
def __init__(self):
- super(StateBuilder, self).__init__()
- self.state = State()
+ super(AllStatesBuilder, self).__init__()
+ self.state = AllStates()
def build(self):
# Make sure that the product is in a valid state, ie not incomplete
@@ -90,10 +90,10 @@ class StateBuilder(object):
# ------------------------------------------
# Factory method for SANStateDataBuilder
# ------------------------------------------
-def get_state_builder(data_info):
+def get_all_states_builder(data_info):
facility = data_info.facility
if facility is SANSFacility.ISIS:
- return StateBuilder()
+ return AllStatesBuilder()
else:
raise NotImplementedError("SANSStateBuilder: Could not find any valid state builder for the "
"specified SANSStateData object {0}".format(str(data_info)))
diff --git a/scripts/SANS/sans/state/IStateParser.py b/scripts/SANS/sans/state/IStateParser.py
new file mode 100644
index 0000000000000000000000000000000000000000..fb96bea41b9027242cec8c4d8743a4140875d88f
--- /dev/null
+++ b/scripts/SANS/sans/state/IStateParser.py
@@ -0,0 +1,84 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+from abc import ABCMeta, abstractmethod
+
+from six import with_metaclass
+
+from sans.state.AllStates import AllStates
+
+
+class IStateParser(with_metaclass(ABCMeta)):
+ def get_all_states(self): # -> AllStates
+ all_states = AllStates()
+ all_states.data = self.get_state_data()
+ all_states.move = self.get_state_move_detectors()
+ all_states.reduction = self.get_state_reduction_mode()
+ all_states.slice = self.get_state_slice_event()
+ all_states.mask = self.get_state_mask_detectors()
+ all_states.wavelength = self.get_state_wavelength()
+ all_states.save = self.get_state_save()
+ all_states.scale = self.get_state_scale()
+ all_states.adjustment = self.get_state_adjustment()
+ all_states.convert_to_q = self.get_state_convert_to_q()
+ all_states.compatibility = self.get_state_compatibility()
+ return all_states
+
+ @abstractmethod
+ def get_state_adjustment(self): # -> StateAdjustment
+ pass
+
+ @abstractmethod
+ def get_state_calculate_transmission(self): # -> StateCalculateTransmission
+ pass
+
+ @abstractmethod
+ def get_state_compatibility(self): # -> StateCompatibility
+ pass
+
+ @abstractmethod
+ def get_state_convert_to_q(self): # -> StateConvertToQ
+ pass
+
+ @abstractmethod
+ def get_state_data(self): # -> StateData
+ pass
+
+ @abstractmethod
+ def get_state_mask_detectors(self): # -> StateMaskDetectors
+ pass
+
+ @abstractmethod
+ def get_state_move_detectors(self): # -> StateMoveDetectors
+ pass
+
+ @abstractmethod
+ def get_state_normalize_to_monitor(self): # -> StateNormalizeToMonitor
+ pass
+
+ @abstractmethod
+ def get_state_reduction_mode(self): # -> StateReductionMode
+ pass
+
+ @abstractmethod
+ def get_state_save(self): # -> StateSave
+ pass
+
+ @abstractmethod
+ def get_state_scale(self): # -> StateScale
+ pass
+
+ @abstractmethod
+ def get_state_slice_event(self): # -> StateSliceEvent
+ pass
+
+ @abstractmethod
+ def get_state_wavelength(self): # -> StateWavelength()
+ pass
+
+ @abstractmethod
+ def get_state_wavelength_and_pixel_adjustment(self): # -> StateWavelengthAndPixelAdjustment
+ pass
diff --git a/scripts/SANS/sans/state/StateBuilder.py b/scripts/SANS/sans/state/StateBuilder.py
new file mode 100644
index 0000000000000000000000000000000000000000..3a982e958301bd92310d504ca74c935bbfa08f44
--- /dev/null
+++ b/scripts/SANS/sans/state/StateBuilder.py
@@ -0,0 +1,68 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+from sans.state.IStateParser import IStateParser
+from sans.state.StateRunDataBuilder import StateRunDataBuilder
+from sans.user_file.txt_parsers.UserFileReaderAdapter import UserFileReaderAdapter
+
+
+class StateBuilder(IStateParser):
+ @staticmethod
+ def new_instance(file_information, data_information, user_filename):
+ run_data = StateRunDataBuilder(file_information=file_information)
+ user_file = UserFileReaderAdapter(data_info=data_information, user_file_name=user_filename)
+ return StateBuilder(run_data_builder=run_data, i_state_parser=user_file)
+
+ def __init__(self, i_state_parser, run_data_builder):
+ self._file_parser = i_state_parser
+ self._run_data_builder = run_data_builder
+
+ def get_all_states(self): # -> AllStates:
+ state = self._file_parser.get_all_states()
+ return self._run_data_builder.pack_all_states(state)
+
+ def get_state_adjustment(self): # -> StateAdjustment:
+ return self._file_parser.get_state_adjustment()
+
+ def get_state_calculate_transmission(self): # -> StateCalculateTransmission:
+ return self._file_parser.get_state_calculate_transmission()
+
+ def get_state_compatibility(self): # -> StateCompatibility:
+ return self._file_parser.get_state_compatibility()
+
+ def get_state_convert_to_q(self): # -> StateConvertToQ:
+ return self._file_parser.get_state_convert_to_q()
+
+ def get_state_data(self): # -> StateData:
+ return self._file_parser.get_state_data()
+
+ def get_state_mask_detectors(self): # -> StateMaskDetectors:
+ return self._file_parser.get_state_mask_detectors()
+
+ def get_state_move_detectors(self): # -> StateMoveDetectors:
+ return self._file_parser.get_state_move_detectors()
+
+ def get_state_normalize_to_monitor(self): # -> StateNormalizeToMonitor:
+ return self._file_parser.get_state_normalize_to_monitor()
+
+ def get_state_reduction_mode(self): # -> StateReductionMode:
+ return self._file_parser.get_state_reduction_mode()
+
+ def get_state_save(self): # -> StateSave:
+ return self._file_parser.get_state_save()
+
+ def get_state_scale(self): # -> StateScale:
+ state = self._file_parser.get_state_scale()
+ return self._run_data_builder.pack_state_scale(state)
+
+ def get_state_slice_event(self): # -> StateSliceEvent:
+ return self._file_parser.get_state_slice_event()
+
+ def get_state_wavelength(self): # -> StateWavelength():
+ return self._file_parser.get_state_wavelength()
+
+ def get_state_wavelength_and_pixel_adjustment(self): # -> StateWavelengthAndPixelAdjustment:
+ return self._file_parser.get_state_wavelength_and_pixel_adjustment()
diff --git a/scripts/SANS/sans/state/adjustment.py b/scripts/SANS/sans/state/StateObjects/StateAdjustment.py
similarity index 100%
rename from scripts/SANS/sans/state/adjustment.py
rename to scripts/SANS/sans/state/StateObjects/StateAdjustment.py
diff --git a/scripts/SANS/sans/state/calculate_transmission.py b/scripts/SANS/sans/state/StateObjects/StateCalculateTransmission.py
similarity index 99%
rename from scripts/SANS/sans/state/calculate_transmission.py
rename to scripts/SANS/sans/state/StateObjects/StateCalculateTransmission.py
index a3723ef43141a6575ce0966b01e6e29e583f1259..754c8ce16cc2173797737b873f02248531e6d884 100644
--- a/scripts/SANS/sans/state/calculate_transmission.py
+++ b/scripts/SANS/sans/state/StateObjects/StateCalculateTransmission.py
@@ -280,9 +280,6 @@ class StateCalculateTransmissionLOQ(StateCalculateTransmission):
def validate(self):
super(StateCalculateTransmissionLOQ, self).validate()
- def set_rebin_type(self, val):
- self.state.rebin_type = val
-
class StateCalculateTransmissionSANS2D(StateCalculateTransmission):
def __init__(self):
diff --git a/scripts/SANS/sans/state/compatibility.py b/scripts/SANS/sans/state/StateObjects/StateCompatibility.py
similarity index 100%
rename from scripts/SANS/sans/state/compatibility.py
rename to scripts/SANS/sans/state/StateObjects/StateCompatibility.py
diff --git a/scripts/SANS/sans/state/convert_to_q.py b/scripts/SANS/sans/state/StateObjects/StateConvertToQ.py
similarity index 100%
rename from scripts/SANS/sans/state/convert_to_q.py
rename to scripts/SANS/sans/state/StateObjects/StateConvertToQ.py
diff --git a/scripts/SANS/sans/state/data.py b/scripts/SANS/sans/state/StateObjects/StateData.py
similarity index 94%
rename from scripts/SANS/sans/state/data.py
rename to scripts/SANS/sans/state/StateObjects/StateData.py
index 03204871fd8ebdeb3a9c84eec3fbf6100e6f3138..46c31adede8880a3b9274e1544ce8d0971aadc5c 100644
--- a/scripts/SANS/sans/state/data.py
+++ b/scripts/SANS/sans/state/StateObjects/StateData.py
@@ -50,7 +50,6 @@ class StateData(with_metaclass(JsonSerializable)):
self.sample_scatter_is_multi_period = None # : Bool
self.idf_file_path = None # : Str()
self.ipf_file_path = None # : Str()
- self.user_file = "" # : Str()
# This should be reset by the builder. Setting this to NoInstrument ensure that we will trip early on,
# in case this is not set, for example by not using the builders.
@@ -103,7 +102,7 @@ class StateData(with_metaclass(JsonSerializable)):
# ----------------------------------------------------------------------------------------------------------------------
# Builder
# ----------------------------------------------------------------------------------------------------------------------
-def set_information_from_file(data_info, file_information, user_file):
+def set_information_from_file(data_info, file_information):
instrument = file_information.get_instrument()
facility = file_information.get_facility()
run_number = file_information.get_run_number()
@@ -113,16 +112,14 @@ def set_information_from_file(data_info, file_information, user_file):
data_info.sample_scatter_is_multi_period = file_information.get_number_of_periods() > 1
data_info.idf_file_path = file_information.get_idf_file_path()
data_info.ipf_file_path = file_information.get_ipf_file_path()
- data_info.user_file = user_file
class StateDataBuilder(object):
@automatic_setters(StateData)
- def __init__(self, file_information, user_file):
+ def __init__(self, file_information):
super(StateDataBuilder, self).__init__()
self.state = StateData()
self._file_information = file_information
- self._user_file = user_file
def build(self):
# Make sure that the product is in a valid state, ie not incomplete
@@ -132,7 +129,7 @@ class StateDataBuilder(object):
# This is currently:
# 1. instrument
# 2. sample_scatter_run_number
- set_information_from_file(self.state, self._file_information, self._user_file)
+ set_information_from_file(self.state, self._file_information)
return copy.copy(self.state)
@@ -140,9 +137,9 @@ class StateDataBuilder(object):
# ------------------------------------------
# Factory method for StateDataBuilder
# ------------------------------------------
-def get_data_builder(facility, file_information=None, user_file=""):
+def get_data_builder(facility, file_information=None):
if facility is SANSFacility.ISIS:
- return StateDataBuilder(file_information, user_file)
+ return StateDataBuilder(file_information)
else:
raise NotImplementedError("StateDataBuilder: The selected facility {0} does not seem"
" to exist".format(str(facility)))
diff --git a/scripts/SANS/sans/state/mask.py b/scripts/SANS/sans/state/StateObjects/StateMaskDetectors.py
similarity index 98%
rename from scripts/SANS/sans/state/mask.py
rename to scripts/SANS/sans/state/StateObjects/StateMaskDetectors.py
index c1bfc8453f87e067f88803dcf7a26b5791465175..39c4b918513db72ab9b7e6d77547b2c6a96c278d 100644
--- a/scripts/SANS/sans/state/mask.py
+++ b/scripts/SANS/sans/state/StateObjects/StateMaskDetectors.py
@@ -83,9 +83,9 @@ def is_spectrum_range_all_on_one_detector(start, stop, invalid_dict, start_name,
# StateData
# ------------------------------------------------
-class StateMaskDetector(with_metaclass(JsonSerializable)):
+class StateMaskDetectors(with_metaclass(JsonSerializable)):
def __init__(self):
- super(StateMaskDetector, self).__init__()
+ super(StateMaskDetectors, self).__init__()
# Vertical strip masks
self.single_vertical_strip_mask = None # : List[Int] (Positive)
self.range_vertical_strip_start = None # : List[Int] (Positive)
@@ -167,7 +167,7 @@ class StateMaskDetector(with_metaclass(JsonSerializable)):
is_invalid, "spectrum_range_start", "spectrum_range_stop", "spectrum_range")
if is_invalid:
- raise ValueError("StateMaskDetector: The provided inputs are illegal. "
+ raise ValueError("StateMaskDetectors: The provided inputs are illegal. "
"Please see: {0}".format(json.dumps(is_invalid)))
@@ -255,8 +255,8 @@ class StateMaskSANS2D(StateMask):
def __init__(self):
super(StateMaskSANS2D, self).__init__()
# Setup the detectors
- self.detectors = {DetectorType.LAB.value: StateMaskDetector(),
- DetectorType.HAB.value: StateMaskDetector()}
+ self.detectors = {DetectorType.LAB.value: StateMaskDetectors(),
+ DetectorType.HAB.value: StateMaskDetectors()}
def validate(self):
super(StateMaskSANS2D, self).validate()
@@ -266,8 +266,8 @@ class StateMaskLOQ(StateMask):
def __init__(self):
super(StateMaskLOQ, self).__init__()
# Setup the detectors
- self.detectors = {DetectorType.LAB.value: StateMaskDetector(),
- DetectorType.HAB.value: StateMaskDetector()}
+ self.detectors = {DetectorType.LAB.value: StateMaskDetectors(),
+ DetectorType.HAB.value: StateMaskDetectors()}
def validate(self):
super(StateMaskLOQ, self).validate()
@@ -277,7 +277,7 @@ class StateMaskLARMOR(StateMask):
def __init__(self):
super(StateMaskLARMOR, self).__init__()
# Setup the detectors
- self.detectors = {DetectorType.LAB.value: StateMaskDetector()}
+ self.detectors = {DetectorType.LAB.value: StateMaskDetectors()}
def validate(self):
super(StateMaskLARMOR, self).validate()
@@ -287,7 +287,7 @@ class StateMaskZOOM(StateMask):
def __init__(self):
super(StateMaskZOOM, self).__init__()
# Setup the detectors
- self.detectors = {DetectorType.LAB.value: StateMaskDetector()}
+ self.detectors = {DetectorType.LAB.value: StateMaskDetectors()}
def validate(self):
super(StateMaskZOOM, self).validate()
diff --git a/scripts/SANS/sans/state/move.py b/scripts/SANS/sans/state/StateObjects/StateMoveDetectors.py
similarity index 98%
rename from scripts/SANS/sans/state/move.py
rename to scripts/SANS/sans/state/StateObjects/StateMoveDetectors.py
index 0836f5ed6c598af830a599500b1b54f927b02754..b64958480ff60b9d131c2d6beeafa5b7d6e9dea9 100644
--- a/scripts/SANS/sans/state/move.py
+++ b/scripts/SANS/sans/state/StateObjects/StateMoveDetectors.py
@@ -25,9 +25,9 @@ from sans.state.state_functions import (validation_message, set_detector_names,
# State
# ----------------------------------------------------------------------------------------------------------------------
-class StateMoveDetector(with_metaclass(JsonSerializable)):
+class StateMoveDetectors(with_metaclass(JsonSerializable)):
def __init__(self):
- super(StateMoveDetector, self).__init__()
+ super(StateMoveDetectors, self).__init__()
# Translation correction
self.x_translation_correction = 0.0 # : Float
self.y_translation_correction = 0.0 # : Float
@@ -97,8 +97,8 @@ class StateMoveLOQ(StateMove):
self.monitor_names = {}
# Setup the detectors
- self.detectors = {DetectorType.LAB.value: StateMoveDetector(),
- DetectorType.HAB.value: StateMoveDetector()}
+ self.detectors = {DetectorType.LAB.value: StateMoveDetectors(),
+ DetectorType.HAB.value: StateMoveDetectors()}
def validate(self):
# No validation of the descriptors on this level, let potential exceptions from detectors "bubble" up
@@ -126,8 +126,8 @@ class StateMoveSANS2D(StateMove):
self.monitor_4_offset = 0.0 # : Float
# Setup the detectors
- self.detectors = {DetectorType.LAB.value: StateMoveDetector(),
- DetectorType.HAB.value: StateMoveDetector()}
+ self.detectors = {DetectorType.LAB.value: StateMoveDetectors(),
+ DetectorType.HAB.value: StateMoveDetectors()}
def validate(self):
super(StateMoveSANS2D, self).validate()
@@ -144,7 +144,7 @@ class StateMoveLARMOR(StateMove):
self.monitor_names = {}
# Setup the detectors
- self.detectors = {DetectorType.LAB.value: StateMoveDetector()}
+ self.detectors = {DetectorType.LAB.value: StateMoveDetectors()}
def validate(self):
super(StateMoveLARMOR, self).validate()
@@ -162,7 +162,7 @@ class StateMoveZOOM(StateMove):
self.monitor_5_offset = 0.0 # : Float
# Setup the detectors
- self.detectors = {DetectorType.LAB.value: StateMoveDetector()}
+ self.detectors = {DetectorType.LAB.value: StateMoveDetectors()}
def validate(self):
super(StateMoveZOOM, self).validate()
diff --git a/scripts/SANS/sans/state/normalize_to_monitor.py b/scripts/SANS/sans/state/StateObjects/StateNormalizeToMonitor.py
similarity index 99%
rename from scripts/SANS/sans/state/normalize_to_monitor.py
rename to scripts/SANS/sans/state/StateObjects/StateNormalizeToMonitor.py
index 69f19f39bea4cfe33b4e0dbdf16df8077f72df8b..d614f2acbfd84ac427a43f1b3fcf45afd5be5205 100644
--- a/scripts/SANS/sans/state/normalize_to_monitor.py
+++ b/scripts/SANS/sans/state/StateObjects/StateNormalizeToMonitor.py
@@ -136,7 +136,7 @@ class StateNormalizeToMonitor(with_metaclass(JsonSerializable)):
is_invalid.update(entry)
if is_invalid:
- raise ValueError("StateMoveDetector: The provided inputs are illegal. "
+ raise ValueError("StateMoveDetectors: The provided inputs are illegal. "
"Please see: {0}".format(json.dumps(is_invalid)))
diff --git a/scripts/SANS/sans/state/reduction_mode.py b/scripts/SANS/sans/state/StateObjects/StateReductionMode.py
similarity index 100%
rename from scripts/SANS/sans/state/reduction_mode.py
rename to scripts/SANS/sans/state/StateObjects/StateReductionMode.py
diff --git a/scripts/SANS/sans/state/save.py b/scripts/SANS/sans/state/StateObjects/StateSave.py
similarity index 100%
rename from scripts/SANS/sans/state/save.py
rename to scripts/SANS/sans/state/StateObjects/StateSave.py
diff --git a/scripts/SANS/sans/state/scale.py b/scripts/SANS/sans/state/StateObjects/StateScale.py
similarity index 88%
rename from scripts/SANS/sans/state/scale.py
rename to scripts/SANS/sans/state/StateObjects/StateScale.py
index c0bf8ad877683ca7ab5d82a132fcbb03416c2537..7f3ad5c80680fcad49e0463eafeaf74197914d65 100644
--- a/scripts/SANS/sans/state/scale.py
+++ b/scripts/SANS/sans/state/StateObjects/StateScale.py
@@ -43,16 +43,17 @@ class StateScale(with_metaclass(JsonSerializable)):
def validate(self):
pass
+ def set_geometry_from_file(self, file_information):
+ # Get the geometry
+ self.height_from_file = file_information.get_height()
+ self.width_from_file = file_information.get_width()
+ self.thickness_from_file = file_information.get_thickness()
+ self.shape_from_file = file_information.get_shape()
+
# ----------------------------------------------------------------------------------------------------------------------
# Builder
# ----------------------------------------------------------------------------------------------------------------------
-def set_geometry_from_file(state, file_information):
- # Get the geometry
- state.height_from_file = file_information.get_height()
- state.width_from_file = file_information.get_width()
- state.thickness_from_file = file_information.get_thickness()
- state.shape_from_file = file_information.get_shape()
class StateScaleBuilder(object):
@@ -60,7 +61,7 @@ class StateScaleBuilder(object):
def __init__(self, file_information):
super(StateScaleBuilder, self).__init__()
self.state = StateScale()
- set_geometry_from_file(self.state, file_information)
+ self.state.set_geometry_from_file(file_information)
def build(self):
self.state.validate()
diff --git a/scripts/SANS/sans/state/slice_event.py b/scripts/SANS/sans/state/StateObjects/StateSliceEvent.py
similarity index 100%
rename from scripts/SANS/sans/state/slice_event.py
rename to scripts/SANS/sans/state/StateObjects/StateSliceEvent.py
diff --git a/scripts/SANS/sans/state/wavelength.py b/scripts/SANS/sans/state/StateObjects/StateWavelength.py
similarity index 100%
rename from scripts/SANS/sans/state/wavelength.py
rename to scripts/SANS/sans/state/StateObjects/StateWavelength.py
diff --git a/scripts/SANS/sans/state/wavelength_and_pixel_adjustment.py b/scripts/SANS/sans/state/StateObjects/StateWavelengthAndPixelAdjustment.py
similarity index 100%
rename from scripts/SANS/sans/state/wavelength_and_pixel_adjustment.py
rename to scripts/SANS/sans/state/StateObjects/StateWavelengthAndPixelAdjustment.py
diff --git a/scripts/Interface/ui/reflectometer/__init__.py b/scripts/SANS/sans/state/StateObjects/__init__.py
similarity index 76%
rename from scripts/Interface/ui/reflectometer/__init__.py
rename to scripts/SANS/sans/state/StateObjects/__init__.py
index d2cfb75232dfb59fac674e2b49dba356e18ebbc1..a352cdce8dd10ff50a564de2b6e4c95bfea3c6d3 100644
--- a/scripts/Interface/ui/reflectometer/__init__.py
+++ b/scripts/SANS/sans/state/StateObjects/__init__.py
@@ -1,6 +1,6 @@
# Mantid Repository : https://github.com/mantidproject/mantid
#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
# NScD Oak Ridge National Laboratory, European Spallation Source
# & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
diff --git a/scripts/SANS/sans/state/StateRunDataBuilder.py b/scripts/SANS/sans/state/StateRunDataBuilder.py
new file mode 100644
index 0000000000000000000000000000000000000000..980b94b30592b424fb5c9d3e1146386e8111cb23
--- /dev/null
+++ b/scripts/SANS/sans/state/StateRunDataBuilder.py
@@ -0,0 +1,23 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+
+
+class StateRunDataBuilder(object):
+ def __init__(self, file_information):
+ self._file_information = file_information
+
+ def pack_all_states(self, all_states):
+ """
+ Packs any fields relevant to the given AllStates object from file information
+ :param all_states: An AllStates object containing default constructed fields
+ :return: all_states with any file information fields populated
+ """
+ # TODO currently this is a shim for the fact that State* objects hold some run information data they
+ # TODO should not hold. Instead StateData should be unpicked from the user file and moved into here
+ state_scale = all_states.scale
+ state_scale.set_geometry_from_file(self._file_information)
+ return all_states
diff --git a/scripts/SANS/sans/state/automatic_setters.py b/scripts/SANS/sans/state/automatic_setters.py
index 9f6557ca7eb43b3ceca854567c58882d099506c7..7d8a0facc48955ced6d322e0fc3f6b76061514ec 100644
--- a/scripts/SANS/sans/state/automatic_setters.py
+++ b/scripts/SANS/sans/state/automatic_setters.py
@@ -44,9 +44,9 @@ def update_the_method(builder_instance, new_methods, setter_name, attribute_nam
setter_name_copy.append(attribute_name)
try:
method_name = "_".join(setter_name_copy)
- except TypeError as e:
- # An enum is being used for a key - the dev needs to switch to a value rather than the enum type
- raise TypeError("You are likely trying to use an enum as a dict key which is not supported.\n {0}".format(e))
+ except TypeError:
+ # An enum is being used for a key - the dev needs to create a manual setter
+ return
attribute_name_list_copy = list(attribute_name_list)
attribute_name_list_copy.append(attribute_name)
diff --git a/scripts/SANS/sans/test_helper/mock_objects.py b/scripts/SANS/sans/test_helper/mock_objects.py
index c5871b261f806c017f38a7fe4856e66fc8b81e4e..861fc01597eb185c78fc8e4a39403940e7ea2eb5 100644
--- a/scripts/SANS/sans/test_helper/mock_objects.py
+++ b/scripts/SANS/sans/test_helper/mock_objects.py
@@ -24,13 +24,13 @@ from ui.sans_isis.beam_centre import BeamCentre
def create_mock_settings_diagnostic_tab():
view = mock.create_autospec(SettingsDiagnosticTab, spec_set=False)
- view.get_current_row = mock.MagicMock(return_value=3)
+ view.get_current_row = mock.MagicMock(return_value=0)
return view
def create_mock_masking_table():
view = mock.create_autospec(MaskingTable, spec_set=False)
- view.get_current_row = mock.MagicMock(return_value=3)
+ view.get_current_row = mock.MagicMock(return_value=0)
return view
@@ -251,7 +251,7 @@ class FakeState(with_metaclass(JsonSerializable)):
def get_state_for_row_mock(row_index, file_lookup=True, suppress_warnings=False):
- return FakeState() if row_index == 3 else ""
+ return FakeState()
def get_state_for_row_mock_with_real_state(row_index, file_lookup=True, suppress_warnings=False):
diff --git a/scripts/SANS/sans/test_helper/test_director.py b/scripts/SANS/sans/test_helper/test_director.py
index 9f58258b073219b857009d183f3c8898986c6beb..9bd61a6c92b5c1322fb141ce83f95cc2461a32ff 100644
--- a/scripts/SANS/sans/test_helper/test_director.py
+++ b/scripts/SANS/sans/test_helper/test_director.py
@@ -6,20 +6,20 @@
# SPDX - License - Identifier: GPL - 3.0 +
""" A Test director """
from __future__ import (absolute_import, division, print_function)
-from sans.state.data import get_data_builder
-from sans.state.move import get_move_builder
-from sans.state.reduction_mode import get_reduction_mode_builder
-from sans.state.slice_event import get_slice_event_builder
-from sans.state.mask import get_mask_builder
-from sans.state.state import get_state_builder
-from sans.state.wavelength import get_wavelength_builder
-from sans.state.save import get_save_builder
-from sans.state.normalize_to_monitor import get_normalize_to_monitor_builder
-from sans.state.scale import get_scale_builder
-from sans.state.calculate_transmission import get_calculate_transmission_builder
-from sans.state.wavelength_and_pixel_adjustment import get_wavelength_and_pixel_adjustment_builder
-from sans.state.adjustment import get_adjustment_builder
-from sans.state.convert_to_q import get_convert_to_q_builder
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateMoveDetectors import get_move_builder
+from sans.state.StateObjects.StateReductionMode import get_reduction_mode_builder
+from sans.state.StateObjects.StateSliceEvent import get_slice_event_builder
+from sans.state.StateObjects.StateMaskDetectors import get_mask_builder
+from sans.state.AllStates import get_all_states_builder
+from sans.state.StateObjects.StateWavelength import get_wavelength_builder
+from sans.state.StateObjects.StateSave import get_save_builder
+from sans.state.StateObjects.StateNormalizeToMonitor import get_normalize_to_monitor_builder
+from sans.state.StateObjects.StateScale import get_scale_builder
+from sans.state.StateObjects.StateCalculateTransmission import get_calculate_transmission_builder
+from sans.state.StateObjects.StateWavelengthAndPixelAdjustment import get_wavelength_and_pixel_adjustment_builder
+from sans.state.StateObjects.StateAdjustment import get_adjustment_builder
+from sans.state.StateObjects.StateConvertToQ import get_convert_to_q_builder
from sans.common.enums import (SANSFacility, ReductionMode, ReductionDimensionality,
FitModeForMerge, RebinType, RangeStepType, SaveType, FitType, SampleShape,
@@ -193,7 +193,7 @@ class TestDirector(object):
self.convert_to_q_state = convert_to_q_builder.build()
# Set the sub states on the SANSState
- state_builder = get_state_builder(self.data_state)
+ state_builder = get_all_states_builder(self.data_state)
state_builder.set_data(self.data_state)
state_builder.set_move(self.move_state)
state_builder.set_reduction(self.reduction_state)
diff --git a/scripts/SANS/sans/user_file/state_director.py b/scripts/SANS/sans/user_file/state_director.py
deleted file mode 100644
index caafa10403d49ec62b786be42a234273c00db590..0000000000000000000000000000000000000000
--- a/scripts/SANS/sans/user_file/state_director.py
+++ /dev/null
@@ -1,1362 +0,0 @@
-# Mantid Repository : https://github.com/mantidproject/mantid
-#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
-# NScD Oak Ridge National Laboratory, European Spallation Source
-# & Institut Laue - Langevin
-# SPDX - License - Identifier: GPL - 3.0 +
-from __future__ import (absolute_import, division, print_function)
-from mantid.kernel import logger
-
-from sans.common.enums import (DetectorType, FitModeForMerge, RebinType, DataType, FitType, RangeStepType)
-from sans.common.file_information import find_full_file_path
-from sans.common.general_functions import (get_ranges_for_rebin_setting, get_ranges_for_rebin_array,
- get_ranges_from_event_slice_setting)
-from sans.state.automatic_setters import set_up_setter_forwarding_from_director_to_builder
-from sans.user_file.user_file_reader import UserFileReader
-from sans.user_file.settings_tags import (DetectorId, BackId, LimitsId, simple_range, complex_range, MaskId,
- rebin_string_values, SampleId, SetId, TransId, TubeCalibrationFileId,
- QResolutionId, FitId, MonId, GravityId, OtherId)
-
-from sans.state.state import get_state_builder
-from sans.state.mask import get_mask_builder
-from sans.state.move import get_move_builder
-from sans.state.reduction_mode import get_reduction_mode_builder
-from sans.state.slice_event import get_slice_event_builder
-from sans.state.wavelength import get_wavelength_builder
-from sans.state.save import get_save_builder
-from sans.state.scale import get_scale_builder
-from sans.state.adjustment import get_adjustment_builder
-from sans.state.normalize_to_monitor import get_normalize_to_monitor_builder
-from sans.state.calculate_transmission import get_calculate_transmission_builder
-from sans.state.wavelength_and_pixel_adjustment import get_wavelength_and_pixel_adjustment_builder
-from sans.state.convert_to_q import get_convert_to_q_builder
-from sans.state.compatibility import get_compatibility_builder
-import collections
-
-
-def check_if_contains_only_one_element(to_check, element_name):
- if len(to_check) > 1:
- msg = "The element {0} contains more than one element. Expected only one element. " \
- "The last element {1} is used. The elements {2} are discarded.".format(element_name,
- to_check[-1], to_check[:-1])
- logger.information(msg)
-
-
-def log_non_existing_field(field):
- msg = "The field {0} does not seem to exist on the state.".format(field)
- logger.information(msg)
-
-
-def convert_detector(detector_type):
- if detector_type is DetectorType.HAB:
- detector_type_as_string = DetectorType.HAB.value
- elif detector_type is DetectorType.LAB:
- detector_type_as_string = DetectorType.LAB.value
- else:
- raise RuntimeError("UserFileStateDirector: Cannot convert detector {0}".format(detector_type))
- return detector_type_as_string
-
-
-def get_min_q_boundary(min_q1, min_q2):
- if not min_q1 and min_q2:
- val = min_q2
- elif min_q1 and not min_q2:
- val = min_q1
- elif not min_q1 and not min_q2:
- val = None
- else:
- val = max(min_q1, min_q2)
- return val
-
-
-def get_max_q_boundary(max_q1, max_q2):
- if not max_q1 and max_q2:
- val = max_q2
- elif max_q1 and not max_q2:
- val = max_q1
- elif not max_q1 and not max_q2:
- val = None
- else:
- val = min(max_q1, max_q2)
- return val
-
-
-def convert_mm_to_m(value):
- return value/1000.
-
-
-def set_background_tof_general(builder, user_file_items):
- # The general background settings
- if BackId.ALL_MONITORS in user_file_items:
- back_all_monitors = user_file_items[BackId.ALL_MONITORS]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(back_all_monitors, BackId.ALL_MONITORS)
- back_all_monitors = back_all_monitors[-1]
- builder.set_background_TOF_general_start(back_all_monitors.start)
- builder.set_background_TOF_general_stop(back_all_monitors.stop)
-
-
-def set_background_tof_monitor(builder, user_file_items):
- # The monitor off switches. Get all monitors which should not have an individual background setting
- monitor_exclusion_list = []
- if BackId.MONITOR_OFF in user_file_items:
- back_monitor_off = user_file_items[BackId.MONITOR_OFF]
- monitor_exclusion_list = list(back_monitor_off.values())
-
- # Get all individual monitor background settings. But ignore those settings where there was an explicit
- # off setting. Those monitors were collected in the monitor_exclusion_list collection
- if BackId.SINGLE_MONITORS in user_file_items:
- background_tof_monitor_start = {}
- background_tof_monitor_stop = {}
- back_single_monitors = user_file_items[BackId.SINGLE_MONITORS]
- for element in back_single_monitors:
- monitor = element.monitor
- if monitor not in monitor_exclusion_list:
- # We need to set it to string since Mantid's Property manager cannot handle integers as a key.
- background_tof_monitor_start.update({str(monitor): element.start})
- background_tof_monitor_stop.update({str(monitor): element.stop})
- builder.set_background_TOF_monitor_start(background_tof_monitor_start)
- builder.set_background_TOF_monitor_stop(background_tof_monitor_stop)
-
-
-def set_wavelength_limits(builder, user_file_items):
- if LimitsId.WAVELENGTH in user_file_items:
- wavelength_limits = user_file_items[LimitsId.WAVELENGTH]
- check_if_contains_only_one_element(wavelength_limits, LimitsId.WAVELENGTH)
- wavelength_limits = wavelength_limits[-1]
-
- if wavelength_limits.step_type in [RangeStepType.RANGE_LIN, RangeStepType.RANGE_LOG]:
- wavelength_range = user_file_items[OtherId.WAVELENGTH_RANGE]
- check_if_contains_only_one_element(wavelength_range, OtherId.WAVELENGTH_RANGE)
- wavelength_range = wavelength_range[-1]
- wavelength_start, wavelength_stop = get_ranges_from_event_slice_setting(wavelength_range)
- wavelength_start = [min(wavelength_start)] + wavelength_start
- wavelength_stop = [max(wavelength_stop)] + wavelength_stop
-
- wavelength_step_type = RangeStepType.LIN if wavelength_limits.step_type is RangeStepType.RANGE_LIN \
- else RangeStepType.LOG
-
- builder.set_wavelength_low(wavelength_start)
- builder.set_wavelength_high(wavelength_stop)
- builder.set_wavelength_step(wavelength_limits.step)
- builder.set_wavelength_step_type(wavelength_step_type)
- else:
- builder.set_wavelength_low([wavelength_limits.start])
- builder.set_wavelength_high([wavelength_limits.stop])
- builder.set_wavelength_step(wavelength_limits.step)
- builder.set_wavelength_step_type(wavelength_limits.step_type)
-
-
-def set_prompt_peak_correction(builder, user_file_items):
- if FitId.MONITOR_TIMES in user_file_items:
- fit_monitor_times = user_file_items[FitId.MONITOR_TIMES]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(fit_monitor_times, FitId.MONITOR_TIMES)
- fit_monitor_times = fit_monitor_times[-1]
- builder.set_prompt_peak_correction_min(fit_monitor_times.start)
- builder.set_prompt_peak_correction_max(fit_monitor_times.stop)
-
-
-def set_single_entry(builder, method_name, tag, all_entries, apply_to_value=None):
- """
- Sets a single element on the specified builder via a specified method name.
-
- If several entries were specified by the user, then the last entry is specified and the
- :param builder: a builder object
- :param method_name: a method on the builder object
- :param tag: the tag of an entry which is potentially part of all_entries
- :param all_entries: all parsed entries
- :param apply_to_value: a function which should be applied before setting the value. If it is None, then nothing
- happens
- """
- if tag in all_entries:
- list_of_entries = all_entries[tag]
- # We expect only one entry, but the user could have specified it several times.
- # If so we want to log it.
- check_if_contains_only_one_element(list_of_entries, tag)
- # We select the entry which was added last.
- entry = list_of_entries[-1]
- if apply_to_value is not None:
- entry = apply_to_value(entry)
- # Set the value on the specified method
- method = getattr(builder, method_name)
- method(entry)
-
-
-class StateDirectorISIS(object):
- def __init__(self, data_info, file_information):
- super(StateDirectorISIS, self).__init__()
- data_info.validate()
- self._data = data_info
-
- self._user_file = None
-
- self._state_builder = get_state_builder(self._data)
- self._mask_builder = get_mask_builder(self._data)
- self._move_builder = get_move_builder(self._data)
- self._reduction_builder = get_reduction_mode_builder(self._data)
- self._slice_event_builder = get_slice_event_builder(self._data)
- self._wavelength_builder = get_wavelength_builder(self._data)
- self._save_builder = get_save_builder(self._data)
- self._scale_builder = get_scale_builder(self._data, file_information)
-
- self._adjustment_builder = get_adjustment_builder(self._data)
- self._normalize_to_monitor_builder = get_normalize_to_monitor_builder(self._data)
- self._calculate_transmission_builder = get_calculate_transmission_builder(self._data)
- self._wavelength_and_pixel_adjustment_builder = get_wavelength_and_pixel_adjustment_builder(self._data)
-
- self._convert_to_q_builder = get_convert_to_q_builder(self._data)
-
- self._compatibility_builder = get_compatibility_builder(self._data)
-
- # Now that we have setup all builders in the director we want to also allow for manual setting
- # of some components. In order to get the desired results we need to perform setter forwarding, e.g
- # self._scale_builder has the setter set_width, then the director should have a method called
- # set_scale_width whose input is forwarded to the actual builder. We can only set this retroactively
- # via monkey-patching.
- self._set_up_setter_forwarding()
-
- def _set_up_setter_forwarding(self):
- set_up_setter_forwarding_from_director_to_builder(self, "_state_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_mask_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_move_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_reduction_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_slice_event_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_wavelength_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_save_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_scale_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_adjustment_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_normalize_to_monitor_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_calculate_transmission_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_wavelength_and_pixel_adjustment_builder")
- set_up_setter_forwarding_from_director_to_builder(self, "_convert_to_q_builder")
-
- set_up_setter_forwarding_from_director_to_builder(self, "_compatibility_builder")
-
- def set_user_file(self, user_file):
- file_path = find_full_file_path(user_file)
- if file_path is None:
- raise RuntimeError("UserFileStateDirector: The specified user file cannot be found. Make sure that the "
- "directory which contains the user file is added to the Mantid path.")
- self._user_file = file_path
- reader = UserFileReader(self._user_file)
- user_file_items = reader.read_user_file()
- self.add_state_settings(user_file_items)
-
- def add_state_settings(self, user_file_items):
- """
- This allows for a usage of the UserFileStateDirector with externally provided user_file_items or internally
- via the set_user_file method.
-
- :param user_file_items: a list of parsed user file items.
- """
- # ----------------------------------------------------
- # Populate the different sub states from the user file
- # ----------------------------------------------------
- # Data state
- self._add_information_to_data_state(user_file_items)
-
- # Mask state
- self._set_up_mask_state(user_file_items)
-
- # Reduction state
- self._set_up_reduction_state(user_file_items)
-
- # Move state
- self._set_up_move_state(user_file_items)
-
- # Wavelength state
- self._set_up_wavelength_state(user_file_items)
-
- # Slice event state
- self._set_up_slice_event_state(user_file_items)
- # There does not seem to be a command for this currently -- this should be added in the future
-
- # Scale state
- self._set_up_scale_state(user_file_items)
-
- # Adjustment state and its substates
- self._set_up_adjustment_state(user_file_items)
- self._set_up_normalize_to_monitor_state(user_file_items)
- self._set_up_calculate_transmission(user_file_items)
- self._set_up_wavelength_and_pixel_adjustment(user_file_items)
-
- # Convert to Q state
- self._set_up_convert_to_q_state(user_file_items)
-
- # Compatibility state
- self._set_up_compatibility(user_file_items)
-
- # Save state
- self._set_up_save(user_file_items)
-
- def construct(self):
- # Create the different sub states and add them to the state
- # Mask state
- mask_state = self._mask_builder.build()
- mask_state.validate()
- self._state_builder.set_mask(mask_state)
-
- # Reduction state
- reduction_state = self._reduction_builder.build()
- reduction_state.validate()
- self._state_builder.set_reduction(reduction_state)
-
- # Move state
- move_state = self._move_builder.build()
- move_state.validate()
- self._state_builder.set_move(move_state)
-
- # Slice Event state
- slice_event_state = self._slice_event_builder.build()
- slice_event_state.validate()
- self._state_builder.set_slice(slice_event_state)
-
- # Wavelength conversion state
- wavelength_state = self._wavelength_builder.build()
- wavelength_state.validate()
- self._state_builder.set_wavelength(wavelength_state)
-
- # Save state
- save_state = self._save_builder.build()
- save_state.validate()
- self._state_builder.set_save(save_state)
-
- # Scale state
- scale_state = self._scale_builder.build()
- scale_state.validate()
- self._state_builder.set_scale(scale_state)
-
- # Adjustment state with the sub states
- normalize_to_monitor_state = self._normalize_to_monitor_builder.build()
- self._adjustment_builder.set_normalize_to_monitor(normalize_to_monitor_state)
-
- calculate_transmission_state = self._calculate_transmission_builder.build()
- self._adjustment_builder.set_calculate_transmission(calculate_transmission_state)
-
- wavelength_and_pixel_adjustment_state = self._wavelength_and_pixel_adjustment_builder.build()
- self._adjustment_builder.set_wavelength_and_pixel_adjustment(wavelength_and_pixel_adjustment_state)
-
- adjustment_state = self._adjustment_builder.build()
- adjustment_state.validate()
-
- self._state_builder.set_adjustment(adjustment_state)
-
- # Convert to Q state
- convert_to_q_state = self._convert_to_q_builder.build()
- convert_to_q_state.validate()
- self._state_builder.set_convert_to_q(convert_to_q_state)
-
- # Compatibility state
- compatibility_state = self._compatibility_builder.build()
- compatibility_state.validate()
- self._state_builder.set_compatibility(compatibility_state)
-
- # Data state
- self._state_builder.set_data(self._data)
-
- return self._state_builder.build()
-
- def _set_up_move_state(self, user_file_items): # noqa
- # The elements which can be set up via the user file are:
- # 1. Correction in X, Y, Z
- # 2. Rotation
- # 3. Side translation
- # 4. Xtilt and Ytilt
- # 5. Sample offset
- # 6. Monitor 4 offset
- # 7. Beam centre
-
- # ---------------------------
- # Correction for X, Y, Z
- # ---------------------------
- if DetectorId.CORRECTION_X in user_file_items:
- corrections_in_x = user_file_items[DetectorId.CORRECTION_X]
- for correction_x in corrections_in_x:
- if correction_x.detector_type is DetectorType.HAB:
- self._move_builder.set_HAB_x_translation_correction(convert_mm_to_m(correction_x.entry))
- elif correction_x.detector_type is DetectorType.LAB:
- self._move_builder.set_LAB_x_translation_correction(convert_mm_to_m(correction_x.entry))
- else:
- raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
- " x correction.".format(correction_x.detector_type))
-
- if DetectorId.CORRECTION_Y in user_file_items:
- corrections_in_y = user_file_items[DetectorId.CORRECTION_Y]
- for correction_y in corrections_in_y:
- if correction_y.detector_type is DetectorType.HAB:
- self._move_builder.set_HAB_y_translation_correction(convert_mm_to_m(correction_y.entry))
- elif correction_y.detector_type is DetectorType.LAB:
- self._move_builder.set_LAB_y_translation_correction(convert_mm_to_m(correction_y.entry))
- else:
- raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
- " y correction.".format(correction_y.detector_type))
-
- if DetectorId.CORRECTION_Z in user_file_items:
- corrections_in_z = user_file_items[DetectorId.CORRECTION_Z]
- for correction_z in corrections_in_z:
- if correction_z.detector_type is DetectorType.HAB:
- self._move_builder.set_HAB_z_translation_correction(convert_mm_to_m(correction_z.entry))
- elif correction_z.detector_type is DetectorType.LAB:
- self._move_builder.set_LAB_z_translation_correction(convert_mm_to_m(correction_z.entry))
- else:
- raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
- " z correction.".format(correction_z.detector_type))
-
- # ---------------------------
- # Correction for Rotation
- # ---------------------------
- if DetectorId.CORRECTION_ROTATION in user_file_items:
- rotation_correction = user_file_items[DetectorId.CORRECTION_ROTATION]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(rotation_correction, DetectorId.CORRECTION_ROTATION)
- rotation_correction = rotation_correction[-1]
- if rotation_correction.detector_type is DetectorType.HAB:
- self._move_builder.set_HAB_rotation_correction(rotation_correction.entry)
- elif rotation_correction.detector_type is DetectorType.LAB:
- self._move_builder.set_LAB_rotation_correction(rotation_correction.entry)
- else:
- raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
- " rotation correction.".format(rotation_correction.detector_type))
-
- # ---------------------------
- # Correction for Radius
- # ---------------------------
- if DetectorId.CORRECTION_RADIUS in user_file_items:
- radius_corrections = user_file_items[DetectorId.CORRECTION_RADIUS]
- for radius_correction in radius_corrections:
- if radius_correction.detector_type is DetectorType.HAB:
- self._move_builder.set_HAB_radius_correction(convert_mm_to_m(radius_correction.entry))
- elif radius_correction.detector_type is DetectorType.LAB:
- self._move_builder.set_LAB_radius_correction(convert_mm_to_m(radius_correction.entry))
- else:
- raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
- " radius correction.".format(radius_correction.detector_type))
-
- # ---------------------------
- # Correction for Translation
- # ---------------------------
- if DetectorId.CORRECTION_TRANSLATION in user_file_items:
- side_corrections = user_file_items[DetectorId.CORRECTION_TRANSLATION]
- for side_correction in side_corrections:
- if side_correction.detector_type is DetectorType.HAB:
- self._move_builder.set_HAB_side_correction(convert_mm_to_m(side_correction.entry))
- elif side_correction.detector_type is DetectorType.LAB:
- self._move_builder.set_LAB_side_correction(convert_mm_to_m(side_correction.entry))
- else:
- raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
- " side correction.".format(side_correction.detector_type))
-
- # ---------------------------
- # Tilt
- # ---------------------------
- if DetectorId.CORRECTION_X_TILT in user_file_items:
- tilt_correction = user_file_items[DetectorId.CORRECTION_X_TILT]
- tilt_correction = tilt_correction[-1]
- if tilt_correction.detector_type is DetectorType.HAB:
- self._move_builder.set_HAB_x_tilt_correction(tilt_correction.entry)
- elif tilt_correction.detector_type is DetectorType.LAB:
- self._move_builder.set_LAB_side_correction(tilt_correction.entry)
- else:
- raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
- " titlt correction.".format(tilt_correction.detector_type))
-
- if DetectorId.CORRECTION_Y_TILT in user_file_items:
- tilt_correction = user_file_items[DetectorId.CORRECTION_Y_TILT]
- tilt_correction = tilt_correction[-1]
- if tilt_correction.detector_type is DetectorType.HAB:
- self._move_builder.set_HAB_y_tilt_correction(tilt_correction.entry)
- elif tilt_correction.detector_type is DetectorType.LAB:
- self._move_builder.set_LAB_side_correction(tilt_correction.entry)
- else:
- raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
- " tilt correction.".format(tilt_correction.detector_type))
-
- # ---------------------------
- # Sample offset
- # ---------------------------
- set_single_entry(self._move_builder, "set_sample_offset", SampleId.OFFSET,
- user_file_items, apply_to_value=convert_mm_to_m)
-
- # ---------------------------
- # Monitor offsets
- # ---------------------------
-
- def parse_shift(key_to_parse, spec_num):
- monitor_n_shift = user_file_items[key_to_parse]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(monitor_n_shift, key_to_parse)
- monitor_n_shift = monitor_n_shift[-1]
-
- # Determine if the object has the set_monitor_X_offset method
- set_monitor_4_offset = getattr(self._move_builder, "set_monitor_4_offset", dict())
- set_monitor_5_offset = getattr(self._move_builder, "set_monitor_5_offset", dict())
-
- if spec_num == 4 and isinstance(set_monitor_4_offset, collections.Callable):
- self._move_builder.set_monitor_4_offset(convert_mm_to_m(monitor_n_shift))
- elif spec_num == 5 and isinstance(set_monitor_5_offset, collections.Callable):
- self._move_builder.set_monitor_5_offset(convert_mm_to_m(monitor_n_shift))
- else:
- log_non_existing_field("set_monitor_{0}_offset".format(spec_num))
-
- if TransId.SPEC_4_SHIFT in user_file_items:
- parse_shift(key_to_parse=TransId.SPEC_4_SHIFT, spec_num=4)
-
- if TransId.SPEC_5_SHIFT in user_file_items:
- parse_shift(key_to_parse=TransId.SPEC_5_SHIFT, spec_num=5)
-
- # ---------------------------
- # Beam Centre, this can be for HAB and LAB
- # ---------------------------
- if SetId.CENTRE in user_file_items:
- beam_centres = user_file_items[SetId.CENTRE]
- beam_centres_for_hab = [beam_centre for beam_centre in beam_centres if beam_centre.detector_type
- is DetectorType.HAB]
- beam_centres_for_lab = [beam_centre for beam_centre in beam_centres if beam_centre.detector_type
- is DetectorType.LAB]
- for beam_centre in beam_centres_for_lab:
- pos1 = beam_centre.pos1
- pos2 = beam_centre.pos2
- self._move_builder.set_LAB_sample_centre_pos1(self._move_builder.convert_pos1(pos1))
- self._move_builder.set_LAB_sample_centre_pos2(self._move_builder.convert_pos2(pos2))
- if hasattr(self._move_builder, "set_HAB_sample_centre_pos1"):
- self._move_builder.set_HAB_sample_centre_pos1(self._move_builder.convert_pos1(pos1))
- if hasattr(self._move_builder, "set_HAB_sample_centre_pos2"):
- self._move_builder.set_HAB_sample_centre_pos2(self._move_builder.convert_pos2(pos2))
-
- for beam_centre in beam_centres_for_hab:
- pos1 = beam_centre.pos1
- pos2 = beam_centre.pos2
- self._move_builder.set_HAB_sample_centre_pos1(self._move_builder.convert_pos1(pos1))
- self._move_builder.set_HAB_sample_centre_pos2(self._move_builder.convert_pos2(pos2))
-
- def _set_up_reduction_state(self, user_file_items):
- # There are several things that can be extracted from the user file
- # 1. The reduction mode
- # 2. The merge behaviour
- # 3. The dimensionality is not set via the user file
-
- # ------------------------
- # Reduction mode
- # ------------------------
- set_single_entry(self._reduction_builder, "set_reduction_mode", DetectorId.REDUCTION_MODE, user_file_items)
-
- # -------------------------------
- # Shift and rescale
- # -------------------------------
- set_single_entry(self._reduction_builder, "set_merge_scale", DetectorId.RESCALE, user_file_items)
- set_single_entry(self._reduction_builder, "set_merge_shift", DetectorId.SHIFT, user_file_items)
-
- # -------------------------------
- # User masking
- # -------------------------------
- merge_min = None
- merge_max = None
- merge_mask = False
- if DetectorId.MERGE_RANGE in user_file_items:
- merge_range = user_file_items[DetectorId.MERGE_RANGE]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(merge_range, DetectorId.RESCALE_FIT)
- merge_range = merge_range[-1]
- merge_min = merge_range.start
- merge_max = merge_range.stop
- merge_mask = merge_range.use_fit
-
- self._reduction_builder.set_merge_mask(merge_mask)
- self._reduction_builder.set_merge_min(merge_min)
- self._reduction_builder.set_merge_max(merge_max)
-
- # -------------------------------
- # Fitting merged
- # -------------------------------
- q_range_min_scale = None
- q_range_max_scale = None
- has_rescale_fit = False
- if DetectorId.RESCALE_FIT in user_file_items:
- rescale_fits = user_file_items[DetectorId.RESCALE_FIT]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(rescale_fits, DetectorId.RESCALE_FIT)
- rescale_fit = rescale_fits[-1]
- q_range_min_scale = rescale_fit.start
- q_range_max_scale = rescale_fit.stop
- has_rescale_fit = rescale_fit.use_fit
-
- q_range_min_shift = None
- q_range_max_shift = None
- has_shift_fit = False
- if DetectorId.SHIFT_FIT in user_file_items:
- shift_fits = user_file_items[DetectorId.SHIFT_FIT]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(shift_fits, DetectorId.SHIFT_FIT)
- shift_fit = shift_fits[-1]
- q_range_min_shift = shift_fit.start
- q_range_max_shift = shift_fit.stop
- has_shift_fit = shift_fit.use_fit
-
- if has_rescale_fit and has_shift_fit:
- self._reduction_builder.set_merge_fit_mode(FitModeForMerge.BOTH)
- min_q = get_min_q_boundary(q_range_min_scale, q_range_min_shift)
- max_q = get_max_q_boundary(q_range_max_scale, q_range_max_shift)
- if min_q:
- self._reduction_builder.set_merge_range_min(min_q)
- if max_q:
- self._reduction_builder.set_merge_range_max(max_q)
- elif has_rescale_fit and not has_shift_fit:
- self._reduction_builder.set_merge_fit_mode(FitModeForMerge.SCALE_ONLY)
- if q_range_min_scale:
- self._reduction_builder.set_merge_range_min(q_range_min_scale)
- if q_range_max_scale:
- self._reduction_builder.set_merge_range_max(q_range_max_scale)
- elif not has_rescale_fit and has_shift_fit:
- self._reduction_builder.set_merge_fit_mode(FitModeForMerge.SHIFT_ONLY)
- if q_range_min_shift:
- self._reduction_builder.set_merge_range_min(q_range_min_shift)
- if q_range_max_shift:
- self._reduction_builder.set_merge_range_max(q_range_max_shift)
- else:
- self._reduction_builder.set_merge_fit_mode(FitModeForMerge.NO_FIT)
-
- # ------------------------
- # Reduction Dimensionality
- # ------------------------
- set_single_entry(self._reduction_builder, "set_reduction_dimensionality", OtherId.REDUCTION_DIMENSIONALITY,
- user_file_items)
-
- def _set_up_mask_state(self, user_file_items): # noqa
- # Check for the various possible masks that can be present in the user file
- # This can be:
- # 1. A line mask
- # 2. A time mask
- # 3. A detector-bound time mask
- # 4. A clean command
- # 5. A time clear command
- # 6. A single spectrum mask
- # 7. A spectrum range mask
- # 8. A vertical single strip mask
- # 9. A vertical range strip mask
- # 10. A horizontal single strip mask
- # 11. A horizontal range strip mask
- # 12. A block mask
- # 13. A cross-type block mask
- # 14. Angle masking
- # 15. Mask files
-
- # ---------------------------------
- # 1. Line Mask
- # ---------------------------------
- if MaskId.LINE in user_file_items:
- mask_lines = user_file_items[MaskId.LINE]
- # If there were several arms specified then we take only the last
- check_if_contains_only_one_element(mask_lines, MaskId.LINE)
- mask_line = mask_lines[-1]
- # We need the width and the angle
- angle = mask_line.angle
- width = convert_mm_to_m(mask_line.width)
- # The position is already specified in meters in the user file
- pos1 = mask_line.x
- pos2 = mask_line.y
- if angle is None or width is None:
- raise RuntimeError("UserFileStateDirector: You specified a line mask without an angle or a width."
- "The parameters were: width {0}; angle {1}; x {2}; y {3}".format(width, angle,
- pos1, pos2))
- pos1 = 0.0 if pos1 is None else pos1
- pos2 = 0.0 if pos2 is None else pos2
-
- self._mask_builder.set_beam_stop_arm_width(width)
- self._mask_builder.set_beam_stop_arm_angle(angle)
- self._mask_builder.set_beam_stop_arm_pos1(pos1)
- self._mask_builder.set_beam_stop_arm_pos2(pos2)
-
- # ---------------------------------
- # 2. General time mask
- # ---------------------------------
- if MaskId.TIME in user_file_items:
- mask_time_general = user_file_items[MaskId.TIME]
- start_time = []
- stop_time = []
- for times in mask_time_general:
- if times.start > times.start:
- raise RuntimeError("UserFileStateDirector: You specified a general time mask with a start time {0}"
- " which is larger than the stop time {1} of the mask. This is not"
- " valid.".format(times.start, times.stop))
- start_time.append(times.start)
- stop_time.append(times.stop)
- self._mask_builder.set_bin_mask_general_start(start_time)
- self._mask_builder.set_bin_mask_general_stop(stop_time)
-
- # ---------------------------------
- # 3. Detector-bound time mask
- # ---------------------------------
- if MaskId.TIME_DETECTOR in user_file_items:
- mask_times = user_file_items[MaskId.TIME_DETECTOR]
- start_times_hab = []
- stop_times_hab = []
- start_times_lab = []
- stop_times_lab = []
- for times in mask_times:
- if times.start > times.start:
- raise RuntimeError("UserFileStateDirector: You specified a general time mask with a start time {0}"
- " which is larger than the stop time {1} of the mask. This is not"
- " valid.".format(times.start, times.stop))
- if times.detector_type is DetectorType.HAB:
- start_times_hab.append(times.start)
- stop_times_hab.append(times.stop)
- elif times.detector_type is DetectorType.LAB:
- start_times_lab.append(times.start)
- stop_times_lab.append(times.stop)
- else:
- RuntimeError("UserFileStateDirector: The specified detector {0} is not "
- "known".format(times.detector_type))
- if start_times_hab:
- self._mask_builder.set_HAB_bin_mask_start(start_times_hab)
- if stop_times_hab:
- self._mask_builder.set_HAB_bin_mask_stop(stop_times_hab)
- if start_times_lab:
- self._mask_builder.set_LAB_bin_mask_start(start_times_lab)
- if stop_times_lab:
- self._mask_builder.set_LAB_bin_mask_stop(stop_times_lab)
-
- # ---------------------------------
- # 4. Clear detector
- # ---------------------------------
- if MaskId.CLEAR_DETECTOR_MASK in user_file_items:
- clear_detector_mask = user_file_items[MaskId.CLEAR_DETECTOR_MASK]
- check_if_contains_only_one_element(clear_detector_mask, MaskId.CLEAR_DETECTOR_MASK)
- # We select the entry which was added last.
- clear_detector_mask = clear_detector_mask[-1]
- self._mask_builder.set_clear(clear_detector_mask)
-
- # ---------------------------------
- # 5. Clear time
- # ---------------------------------
- if MaskId.CLEAR_TIME_MASK in user_file_items:
- clear_time_mask = user_file_items[MaskId.CLEAR_TIME_MASK]
- check_if_contains_only_one_element(clear_time_mask, MaskId.CLEAR_TIME_MASK)
- # We select the entry which was added last.
- clear_time_mask = clear_time_mask[-1]
- self._mask_builder.set_clear_time(clear_time_mask)
-
- # ---------------------------------
- # 6. Single Spectrum
- # ---------------------------------
- if MaskId.SINGLE_SPECTRUM_MASK in user_file_items:
- single_spectra = user_file_items[MaskId.SINGLE_SPECTRUM_MASK]
- # Note that we are using an unusual setter here. Check mask.py for why we are doing this.
- self._mask_builder.set_single_spectra_on_detector(single_spectra)
-
- # ---------------------------------
- # 7. Spectrum Range
- # ---------------------------------
- if MaskId.SPECTRUM_RANGE_MASK in user_file_items:
- spectrum_ranges = user_file_items[MaskId.SPECTRUM_RANGE_MASK]
- start_range = []
- stop_range = []
- for spectrum_range in spectrum_ranges:
- if spectrum_range.start > spectrum_range.start:
- raise RuntimeError("UserFileStateDirector: You specified a spectrum range with a start value {0}"
- " which is larger than the stop value {1}. This is not"
- " valid.".format(spectrum_range.start, spectrum_range.stop))
- start_range.append(spectrum_range.start)
- stop_range.append(spectrum_range.stop)
- # Note that we are using an unusual setter here. Check mask.py for why we are doing this.
- self._mask_builder.set_spectrum_range_on_detector(start_range, stop_range)
-
- # ---------------------------------
- # 8. Vertical single strip
- # ---------------------------------
- if MaskId.VERTICAL_SINGLE_STRIP_MASK in user_file_items:
- single_vertical_strip_masks = user_file_items[MaskId.VERTICAL_SINGLE_STRIP_MASK]
- entry_hab = []
- entry_lab = []
- for single_vertical_strip_mask in single_vertical_strip_masks:
- if single_vertical_strip_mask.detector_type is DetectorType.HAB:
- entry_hab.append(single_vertical_strip_mask.entry)
- elif single_vertical_strip_mask.detector_type is DetectorType.LAB:
- entry_lab.append(single_vertical_strip_mask.entry)
- else:
- raise RuntimeError("UserFileStateDirector: The vertical single strip mask {0} has an unknown "
- "detector {1} associated"
- " with it.".format(single_vertical_strip_mask.entry,
- single_vertical_strip_mask.detector_type))
- if entry_hab:
- self._mask_builder.set_HAB_single_vertical_strip_mask(entry_hab)
- if entry_lab:
- self._mask_builder.set_LAB_single_vertical_strip_mask(entry_lab)
-
- # ---------------------------------
- # 9. Vertical range strip
- # ---------------------------------
- if MaskId.VERTICAL_RANGE_STRIP_MASK in user_file_items:
- range_vertical_strip_masks = user_file_items[MaskId.VERTICAL_RANGE_STRIP_MASK]
- start_hab = []
- stop_hab = []
- start_lab = []
- stop_lab = []
- for range_vertical_strip_mask in range_vertical_strip_masks:
- if range_vertical_strip_mask.detector_type is DetectorType.HAB:
- start_hab.append(range_vertical_strip_mask.start)
- stop_hab.append(range_vertical_strip_mask.stop)
- elif range_vertical_strip_mask.detector_type is DetectorType.LAB:
- start_lab.append(range_vertical_strip_mask.start)
- stop_lab.append(range_vertical_strip_mask.stop)
- else:
- raise RuntimeError("UserFileStateDirector: The vertical range strip mask {0} has an unknown "
- "detector {1} associated "
- "with it.".format(range_vertical_strip_mask.entry,
- range_vertical_strip_mask.detector_type))
- if start_hab:
- self._mask_builder.set_HAB_range_vertical_strip_start(start_hab)
- if stop_hab:
- self._mask_builder.set_HAB_range_vertical_strip_stop(stop_hab)
- if start_lab:
- self._mask_builder.set_LAB_range_vertical_strip_start(start_lab)
- if stop_lab:
- self._mask_builder.set_LAB_range_vertical_strip_stop(stop_lab)
-
- # ---------------------------------
- # 10. Horizontal single strip
- # ---------------------------------
- if MaskId.HORIZONTAL_SINGLE_STRIP_MASK in user_file_items:
- single_horizontal_strip_masks = user_file_items[MaskId.HORIZONTAL_SINGLE_STRIP_MASK]
- entry_hab = []
- entry_lab = []
- for single_horizontal_strip_mask in single_horizontal_strip_masks:
- if single_horizontal_strip_mask.detector_type is DetectorType.HAB:
- entry_hab.append(single_horizontal_strip_mask.entry)
- elif single_horizontal_strip_mask.detector_type is DetectorType.LAB:
- entry_lab.append(single_horizontal_strip_mask.entry)
- else:
- raise RuntimeError("UserFileStateDirector: The horizontal single strip mask {0} has an unknown "
- "detector {1} associated"
- " with it.".format(single_horizontal_strip_mask.entry,
- single_horizontal_strip_mask.detector_type))
- if entry_hab:
- self._mask_builder.set_HAB_single_horizontal_strip_mask(entry_hab)
- if entry_lab:
- self._mask_builder.set_LAB_single_horizontal_strip_mask(entry_lab)
-
- # ---------------------------------
- # 11. Horizontal range strip
- # ---------------------------------
- if MaskId.HORIZONTAL_RANGE_STRIP_MASK in user_file_items:
- range_horizontal_strip_masks = user_file_items[MaskId.HORIZONTAL_RANGE_STRIP_MASK]
- start_hab = []
- stop_hab = []
- start_lab = []
- stop_lab = []
- for range_horizontal_strip_mask in range_horizontal_strip_masks:
- if range_horizontal_strip_mask.detector_type is DetectorType.HAB:
- start_hab.append(range_horizontal_strip_mask.start)
- stop_hab.append(range_horizontal_strip_mask.stop)
- elif range_horizontal_strip_mask.detector_type is DetectorType.LAB:
- start_lab.append(range_horizontal_strip_mask.start)
- stop_lab.append(range_horizontal_strip_mask.stop)
- else:
- raise RuntimeError("UserFileStateDirector: The vertical range strip mask {0} has an unknown "
- "detector {1} associated "
- "with it.".format(range_horizontal_strip_mask.entry,
- range_horizontal_strip_mask.detector_type))
- if start_hab:
- self._mask_builder.set_HAB_range_horizontal_strip_start(start_hab)
- if stop_hab:
- self._mask_builder.set_HAB_range_horizontal_strip_stop(stop_hab)
- if start_lab:
- self._mask_builder.set_LAB_range_horizontal_strip_start(start_lab)
- if stop_lab:
- self._mask_builder.set_LAB_range_horizontal_strip_stop(stop_lab)
-
- # ---------------------------------
- # 12. Block
- # ---------------------------------
- if MaskId.BLOCK in user_file_items:
- blocks = user_file_items[MaskId.BLOCK]
- horizontal_start_hab = []
- horizontal_stop_hab = []
- vertical_start_hab = []
- vertical_stop_hab = []
- horizontal_start_lab = []
- horizontal_stop_lab = []
- vertical_start_lab = []
- vertical_stop_lab = []
-
- for block in blocks:
- if block.horizontal1 > block.horizontal2 or block.vertical1 > block.vertical2:
- raise RuntimeError("UserFileStateDirector: The block mask seems to have inconsistent entries. "
- "The values are horizontal_start {0}; horizontal_stop {1}; vertical_start {2};"
- " vertical_stop {3}".format(block.horizontal1, block.horizontal2,
- block.vertical1, block.vertical2))
- if block.detector_type is DetectorType.HAB:
- horizontal_start_hab.append(block.horizontal1)
- horizontal_stop_hab.append(block.horizontal2)
- vertical_start_hab.append(block.vertical1)
- vertical_stop_hab.append(block.vertical2)
- elif block.detector_type is DetectorType.LAB:
- horizontal_start_lab.append(block.horizontal1)
- horizontal_stop_lab.append(block.horizontal2)
- vertical_start_lab.append(block.vertical1)
- vertical_stop_lab.append(block.vertical2)
- else:
- raise RuntimeError("UserFileStateDirector: The block mask has an unknown "
- "detector {0} associated "
- "with it.".format(block.detector_type))
- if horizontal_start_hab:
- self._mask_builder.set_HAB_block_horizontal_start(horizontal_start_hab)
- if horizontal_stop_hab:
- self._mask_builder.set_HAB_block_horizontal_stop(horizontal_stop_hab)
- if vertical_start_lab:
- self._mask_builder.set_LAB_block_vertical_start(vertical_start_lab)
- if vertical_stop_lab:
- self._mask_builder.set_LAB_block_vertical_stop(vertical_stop_lab)
-
- # ---------------------------------
- # 13. Block cross
- # ---------------------------------
- if MaskId.BLOCK_CROSS in user_file_items:
- block_crosses = user_file_items[MaskId.BLOCK_CROSS]
- horizontal_hab = []
- vertical_hab = []
- horizontal_lab = []
- vertical_lab = []
- for block_cross in block_crosses:
- if block_cross.detector_type is DetectorType.HAB:
- horizontal_hab.append(block_cross.horizontal)
- vertical_hab.append(block_cross.vertical)
- elif block_cross.detector_type is DetectorType.LAB:
- horizontal_lab.append(block_cross.horizontal)
- vertical_lab.append(block_cross.vertical)
- else:
- raise RuntimeError("UserFileStateDirector: The block cross mask has an unknown "
- "detector {0} associated "
- "with it.".format(block_cross.detector_type))
- if horizontal_hab:
- self._mask_builder.set_HAB_block_cross_horizontal(horizontal_hab)
- if vertical_hab:
- self._mask_builder.set_HAB_block_cross_vertical(vertical_hab)
- if horizontal_lab:
- self._mask_builder.set_LAB_block_cross_horizontal(horizontal_lab)
- if vertical_lab:
- self._mask_builder.set_LAB_block_cross_vertical(vertical_lab)
-
- # ------------------------------------------------------------
- # 14. Angles --> they are specified in L/Phi
- # -----------------------------------------------------------
- if LimitsId.ANGLE in user_file_items:
- angles = user_file_items[LimitsId.ANGLE]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(angles, LimitsId.ANGLE)
- angle = angles[-1]
- self._mask_builder.set_phi_min(angle.min)
- self._mask_builder.set_phi_max(angle.max)
- self._mask_builder.set_use_mask_phi_mirror(angle.use_mirror)
-
- # ------------------------------------------------------------
- # 15. Maskfiles
- # -----------------------------------------------------------
- if MaskId.FILE in user_file_items:
- mask_files = user_file_items[MaskId.FILE]
- self._mask_builder.set_mask_files(mask_files)
-
- # ------------------------------------------------------------
- # 16. Radius masks
- # -----------------------------------------------------------
- if LimitsId.RADIUS in user_file_items:
- radii = user_file_items[LimitsId.RADIUS]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(radii, LimitsId.RADIUS)
- radius = radii[-1]
- if radius.start > radius.stop > 0:
- raise RuntimeError("UserFileStateDirector: The inner radius {0} appears to be larger that the outer"
- " radius {1} of the mask.".format(radius.start, radius.stop))
- min_value = None if radius.start is None else convert_mm_to_m(radius.start)
- max_value = None if radius.stop is None else convert_mm_to_m(radius.stop)
- self._mask_builder.set_radius_min(min_value)
- self._mask_builder.set_radius_max(max_value)
-
- def _set_up_wavelength_state(self, user_file_items):
- set_wavelength_limits(self._wavelength_builder, user_file_items)
-
- def _set_up_slice_event_state(self, user_file_items):
- # Setting up the slice limits is current
- if OtherId.EVENT_SLICES in user_file_items:
- event_slices = user_file_items[OtherId.EVENT_SLICES]
- check_if_contains_only_one_element(event_slices, OtherId.EVENT_SLICES)
- event_slices = event_slices[-1]
- # The events binning can come in three forms.
- # 1. As a simple range object
- # 2. As an already parsed rebin array, ie min, step, max
- # 3. As a string. Note that this includes custom commands.
- if isinstance(event_slices, simple_range):
- start, stop = get_ranges_for_rebin_setting(event_slices.start, event_slices.stop,
- event_slices.step, event_slices.step_type)
- elif isinstance(event_slices, rebin_string_values):
- start, stop = get_ranges_for_rebin_array(event_slices.value)
- else:
- start, stop = get_ranges_from_event_slice_setting(event_slices.value)
- self._slice_event_builder.set_start_time(start)
- self._slice_event_builder.set_end_time(stop)
-
- def _set_up_scale_state(self, user_file_items):
- # We only extract the first entry here, ie the s entry. Although there are other entries which a user can
- # specify such as a, b, c, d they seem to be
- if SetId.SCALES in user_file_items:
- scales = user_file_items[SetId.SCALES]
- check_if_contains_only_one_element(scales, SetId.SCALES)
- scales = scales[-1]
- self._scale_builder.set_scale(scales.s)
-
- # We can also have settings for the sample geometry (Note that at the moment this is not settable via the
- # user file nor the command line interface
- if OtherId.SAMPLE_SHAPE in user_file_items:
- sample_shape = user_file_items[OtherId.SAMPLE_SHAPE]
- check_if_contains_only_one_element(sample_shape, OtherId.SAMPLE_SHAPE)
- sample_shape = sample_shape[-1]
- self._scale_builder.set_shape(sample_shape)
-
- if OtherId.SAMPLE_WIDTH in user_file_items:
- sample_width = user_file_items[OtherId.SAMPLE_WIDTH]
- check_if_contains_only_one_element(sample_width, OtherId.SAMPLE_WIDTH)
- sample_width = sample_width[-1]
- self._scale_builder.set_width(sample_width)
-
- if OtherId.SAMPLE_HEIGHT in user_file_items:
- sample_height = user_file_items[OtherId.SAMPLE_HEIGHT]
- check_if_contains_only_one_element(sample_height, OtherId.SAMPLE_HEIGHT)
- sample_height = sample_height[-1]
- self._scale_builder.set_height(sample_height)
-
- if OtherId.SAMPLE_THICKNESS in user_file_items:
- sample_thickness = user_file_items[OtherId.SAMPLE_THICKNESS]
- check_if_contains_only_one_element(sample_thickness, OtherId.SAMPLE_THICKNESS)
- sample_thickness = sample_thickness[-1]
- self._scale_builder.set_thickness(sample_thickness)
-
- def _set_up_convert_to_q_state(self, user_file_items):
- # Get the radius cut off if any is present
- set_single_entry(self._convert_to_q_builder, "set_radius_cutoff", LimitsId.RADIUS_CUT, user_file_items,
- apply_to_value=convert_mm_to_m)
-
- # Get the wavelength cut off if any is present
- set_single_entry(self._convert_to_q_builder, "set_wavelength_cutoff", LimitsId.WAVELENGTH_CUT,
- user_file_items)
-
- # Get the 1D q values
- if LimitsId.Q in user_file_items:
- limits_q = user_file_items[LimitsId.Q]
- check_if_contains_only_one_element(limits_q, LimitsId.Q)
- limits_q = limits_q[-1]
- self._convert_to_q_builder.set_q_min(limits_q.min)
- self._convert_to_q_builder.set_q_max(limits_q.max)
- self._convert_to_q_builder.set_q_1d_rebin_string(limits_q.rebin_string)
-
- # Get the 2D q values
- if LimitsId.QXY in user_file_items:
- limits_qxy = user_file_items[LimitsId.QXY]
- check_if_contains_only_one_element(limits_qxy, LimitsId.QXY)
- limits_qxy = limits_qxy[-1]
- # Now we have to check if we have a simple pattern or a more complex pattern at hand
- is_complex = isinstance(limits_qxy, complex_range)
- self._convert_to_q_builder.set_q_xy_max(limits_qxy.stop)
- if is_complex:
- # Note that it has not been implemented in the old reducer, but the documentation is
- # suggesting that it is available. Hence we throw here.
- raise RuntimeError("Qxy cannot handle settings of type: L/Q l1,dl1,l3,dl2,l2 [/LIN|/LOG] ")
- else:
- self._convert_to_q_builder.set_q_xy_step(limits_qxy.step)
- self._convert_to_q_builder.set_q_xy_step_type(limits_qxy.step_type)
-
- # Get the Gravity settings
- set_single_entry(self._convert_to_q_builder, "set_use_gravity", GravityId.ON_OFF, user_file_items)
- set_single_entry(self._convert_to_q_builder, "set_gravity_extra_length", GravityId.EXTRA_LENGTH,
- user_file_items)
-
- # Get the QResolution settings set_q_resolution_delta_r
- set_single_entry(self._convert_to_q_builder, "set_use_q_resolution", QResolutionId.ON, user_file_items)
- set_single_entry(self._convert_to_q_builder, "set_q_resolution_delta_r", QResolutionId.DELTA_R,
- user_file_items, apply_to_value=convert_mm_to_m)
- set_single_entry(self._convert_to_q_builder, "set_q_resolution_collimation_length",
- QResolutionId.COLLIMATION_LENGTH, user_file_items)
- set_single_entry(self._convert_to_q_builder, "set_q_resolution_a1", QResolutionId.A1, user_file_items,
- apply_to_value=convert_mm_to_m)
- set_single_entry(self._convert_to_q_builder, "set_q_resolution_a2", QResolutionId.A2, user_file_items,
- apply_to_value=convert_mm_to_m)
- set_single_entry(self._convert_to_q_builder, "set_moderator_file", QResolutionId.MODERATOR,
- user_file_items)
- set_single_entry(self._convert_to_q_builder, "set_q_resolution_h1", QResolutionId.H1, user_file_items,
- apply_to_value=convert_mm_to_m)
- set_single_entry(self._convert_to_q_builder, "set_q_resolution_h2", QResolutionId.H2, user_file_items,
- apply_to_value=convert_mm_to_m)
- set_single_entry(self._convert_to_q_builder, "set_q_resolution_w1", QResolutionId.W1, user_file_items,
- apply_to_value=convert_mm_to_m)
- set_single_entry(self._convert_to_q_builder, "set_q_resolution_w2", QResolutionId.W2, user_file_items,
- apply_to_value=convert_mm_to_m)
-
- # ------------------------
- # Reduction Dimensionality
- # ------------------------
- set_single_entry(self._convert_to_q_builder, "set_reduction_dimensionality", OtherId.REDUCTION_DIMENSIONALITY,
- user_file_items)
-
- def _set_up_adjustment_state(self, user_file_items):
- # Get the wide angle correction setting
- set_single_entry(self._adjustment_builder, "set_wide_angle_correction", SampleId.PATH, user_file_items)
-
- def _set_up_normalize_to_monitor_state(self, user_file_items):
- # Extract the incident monitor and which type of rebinning to use (interpolating or normal)
- if MonId.SPECTRUM in user_file_items:
- mon_spectrum = user_file_items[MonId.SPECTRUM]
- mon_spec = [spec for spec in mon_spectrum if not spec.is_trans]
-
- if mon_spec:
- mon_spec = mon_spec[-1]
- rebin_type = RebinType.INTERPOLATING_REBIN if mon_spec.interpolate else RebinType.REBIN
- self._normalize_to_monitor_builder.set_rebin_type(rebin_type)
-
- # We have to check if the spectrum is None, this can be the case when the user wants to use the
- # default incident monitor spectrum
- if mon_spec.spectrum:
- self._normalize_to_monitor_builder.set_incident_monitor(mon_spec.spectrum)
-
- # The prompt peak correction values
- set_prompt_peak_correction(self._normalize_to_monitor_builder, user_file_items)
-
- # The general background settings
- set_background_tof_general(self._normalize_to_monitor_builder, user_file_items)
-
- # The monitor-specific background settings
- set_background_tof_monitor(self._normalize_to_monitor_builder, user_file_items)
-
- # Get the wavelength rebin settings
- set_wavelength_limits(self._normalize_to_monitor_builder, user_file_items)
-
- def _set_up_calculate_transmission(self, user_file_items):
- # Transmission radius
- set_single_entry(self._calculate_transmission_builder, "set_transmission_radius_on_detector", TransId.RADIUS,
- user_file_items, apply_to_value=convert_mm_to_m)
-
- # List of transmission roi files
- if TransId.ROI in user_file_items:
- trans_roi = user_file_items[TransId.ROI]
- self._calculate_transmission_builder.set_transmission_roi_files(trans_roi)
-
- # List of transmission mask files
- if TransId.MASK in user_file_items:
- trans_mask = user_file_items[TransId.MASK]
- self._calculate_transmission_builder.set_transmission_mask_files(trans_mask)
-
- # The prompt peak correction values
- set_prompt_peak_correction(self._calculate_transmission_builder, user_file_items)
-
- # The transmission spectrum
- if TransId.SPEC in user_file_items:
- trans_spec = user_file_items[TransId.SPEC]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(trans_spec, TransId.SPEC)
- trans_spec = trans_spec[-1]
- self._calculate_transmission_builder.set_transmission_monitor(trans_spec)
-
- # The incident monitor spectrum for transmission calculation
- if MonId.SPECTRUM in user_file_items:
- mon_spectrum = user_file_items[MonId.SPECTRUM]
- mon_spec = [spec for spec in mon_spectrum if spec.is_trans]
- if mon_spec:
- mon_spec = mon_spec[-1]
- rebin_type = RebinType.INTERPOLATING_REBIN if mon_spec.interpolate else RebinType.REBIN
- self._calculate_transmission_builder.set_rebin_type(rebin_type)
-
- # We have to check if the spectrum is None, this can be the case when the user wants to use the
- # default incident monitor spectrum
- if mon_spec.spectrum:
- self._calculate_transmission_builder.set_incident_monitor(mon_spec.spectrum)
-
- # The general background settings
- set_background_tof_general(self._calculate_transmission_builder, user_file_items)
-
- # The monitor-specific background settings
- set_background_tof_monitor(self._calculate_transmission_builder, user_file_items)
-
- # The roi-specific background settings
- if BackId.TRANS in user_file_items:
- back_trans = user_file_items[BackId.TRANS]
- # Should the user have chosen several values, then the last element is selected
- check_if_contains_only_one_element(back_trans, BackId.TRANS)
- back_trans = back_trans[-1]
- self._calculate_transmission_builder.set_background_TOF_roi_start(back_trans.start)
- self._calculate_transmission_builder.set_background_TOF_roi_stop(back_trans.stop)
-
- # Set the fit settings
- if FitId.GENERAL in user_file_items:
- fit_general = user_file_items[FitId.GENERAL]
- # We can have settings for both the sample or the can or individually
- # There can be three types of settings:
- # 1. Clearing the fit setting
- # 2. General settings where the entry data_type is not specified. Settings apply to both sample and can
- # 3. Sample settings
- # 4. Can settings
- # We first apply the general settings. Specialized settings for can or sample override the general settings
- # As usual if there are multiple settings for a specific case, then the last in the list is used.
-
- # 1 Fit type settings
- clear_settings = [item for item in fit_general if item.data_type is None and item.fit_type is FitType.NO_FIT]
-
- if clear_settings:
- check_if_contains_only_one_element(clear_settings, FitId.GENERAL)
- clear_settings = clear_settings[-1]
- # Will set the fitting to NoFit
- self._calculate_transmission_builder.set_sample_fit_type(clear_settings.fit_type)
- self._calculate_transmission_builder.set_can_fit_type(clear_settings.fit_type)
-
- # 2. General settings
- general_settings = [item for item in fit_general if item.data_type is None and
- item.fit_type is not FitType.NO_FIT]
- if general_settings:
- check_if_contains_only_one_element(general_settings, FitId.GENERAL)
- general_settings = general_settings[-1]
- self._calculate_transmission_builder.set_sample_fit_type(general_settings.fit_type)
- self._calculate_transmission_builder.set_sample_polynomial_order(general_settings.polynomial_order)
- self._calculate_transmission_builder.set_sample_wavelength_low(general_settings.start)
- self._calculate_transmission_builder.set_sample_wavelength_high(general_settings.stop)
- self._calculate_transmission_builder.set_can_fit_type(general_settings.fit_type)
- self._calculate_transmission_builder.set_can_polynomial_order(general_settings.polynomial_order)
- self._calculate_transmission_builder.set_can_wavelength_low(general_settings.start)
- self._calculate_transmission_builder.set_can_wavelength_high(general_settings.stop)
-
- # 3. Sample settings
- sample_settings = [item for item in fit_general if item.data_type is DataType.SAMPLE]
- if sample_settings:
- check_if_contains_only_one_element(sample_settings, FitId.GENERAL)
- sample_settings = sample_settings[-1]
- self._calculate_transmission_builder.set_sample_fit_type(sample_settings.fit_type)
- self._calculate_transmission_builder.set_sample_polynomial_order(sample_settings.polynomial_order)
- self._calculate_transmission_builder.set_sample_wavelength_low(sample_settings.start)
- self._calculate_transmission_builder.set_sample_wavelength_high(sample_settings.stop)
-
- # 4. Can settings
- can_settings = [item for item in fit_general if item.data_type is DataType.CAN]
- if can_settings:
- check_if_contains_only_one_element(can_settings, FitId.GENERAL)
- can_settings = can_settings[-1]
- self._calculate_transmission_builder.set_can_fit_type(can_settings.fit_type)
- self._calculate_transmission_builder.set_can_polynomial_order(can_settings.polynomial_order)
- self._calculate_transmission_builder.set_can_wavelength_low(can_settings.start)
- self._calculate_transmission_builder.set_can_wavelength_high(can_settings.stop)
-
- # Set the wavelength default configuration
- set_wavelength_limits(self._calculate_transmission_builder, user_file_items)
-
- # Set the full wavelength range. Note that this can currently only be set from the ISISCommandInterface
- if OtherId.USE_FULL_WAVELENGTH_RANGE in user_file_items:
- use_full_wavelength_range = user_file_items[OtherId.USE_FULL_WAVELENGTH_RANGE]
- check_if_contains_only_one_element(use_full_wavelength_range, OtherId.USE_FULL_WAVELENGTH_RANGE)
- use_full_wavelength_range = use_full_wavelength_range[-1]
- self._calculate_transmission_builder.set_use_full_wavelength_range(use_full_wavelength_range)
-
- def _set_up_wavelength_and_pixel_adjustment(self, user_file_items):
- # Get the flat/flood files. There can be entries for LAB and HAB.
- if MonId.FLAT in user_file_items:
- mon_flat = user_file_items[MonId.FLAT]
- hab_flat_entries = [item for item in mon_flat if item.detector_type is DetectorType.HAB]
- lab_flat_entries = [item for item in mon_flat if item.detector_type is DetectorType.LAB]
- if hab_flat_entries:
- hab_flat_entry = hab_flat_entries[-1]
- self._wavelength_and_pixel_adjustment_builder.set_HAB_pixel_adjustment_file(hab_flat_entry.file_path)
-
- if lab_flat_entries:
- lab_flat_entry = lab_flat_entries[-1]
- self._wavelength_and_pixel_adjustment_builder.set_LAB_pixel_adjustment_file(lab_flat_entry.file_path)
-
- # Get the direct files. There can be entries for LAB and HAB.
- if MonId.DIRECT in user_file_items:
- mon_direct = user_file_items[MonId.DIRECT]
- hab_direct_entries = [item for item in mon_direct if item.detector_type is DetectorType.HAB]
- lab_direct_entries = [item for item in mon_direct if item.detector_type is DetectorType.LAB]
- if hab_direct_entries:
- hab_direct_entry = hab_direct_entries[-1]
- self._wavelength_and_pixel_adjustment_builder.set_HAB_wavelength_adjustment_file(
- hab_direct_entry.file_path)
-
- if lab_direct_entries:
- lab_direct_entry = lab_direct_entries[-1]
- self._wavelength_and_pixel_adjustment_builder.set_LAB_wavelength_adjustment_file(
- lab_direct_entry.file_path)
-
- # Set up the wavelength
- set_wavelength_limits(self._wavelength_and_pixel_adjustment_builder, user_file_items)
-
- def _set_up_compatibility(self, user_file_items):
- if LimitsId.EVENTS_BINNING in user_file_items:
- events_binning = user_file_items[LimitsId.EVENTS_BINNING]
- check_if_contains_only_one_element(events_binning, LimitsId.EVENTS_BINNING)
- events_binning = events_binning[-1]
- self._compatibility_builder.set_time_rebin_string(events_binning)
-
- if OtherId.USE_COMPATIBILITY_MODE in user_file_items:
- use_compatibility_mode = user_file_items[OtherId.USE_COMPATIBILITY_MODE]
- check_if_contains_only_one_element(use_compatibility_mode, OtherId.USE_COMPATIBILITY_MODE)
- use_compatibility_mode = use_compatibility_mode[-1]
- self._compatibility_builder.set_use_compatibility_mode(use_compatibility_mode)
-
- if OtherId.USE_EVENT_SLICE_OPTIMISATION in user_file_items:
- use_event_slice_optimisation = user_file_items[OtherId.USE_EVENT_SLICE_OPTIMISATION]
- check_if_contains_only_one_element(use_event_slice_optimisation, OtherId.USE_EVENT_SLICE_OPTIMISATION)
- use_event_slice_optimisation = use_event_slice_optimisation[-1]
- self._compatibility_builder.set_use_event_slice_optimisation(use_event_slice_optimisation)
-
- def _set_up_save(self, user_file_items):
- if OtherId.SAVE_TYPES in user_file_items:
- save_types = user_file_items[OtherId.SAVE_TYPES]
- check_if_contains_only_one_element(save_types, OtherId.SAVE_TYPES)
- save_types = save_types[-1]
- self._save_builder.set_file_format(save_types)
-
- if OtherId.SAVE_AS_ZERO_ERROR_FREE in user_file_items:
- save_as_zero_error_free = user_file_items[OtherId.SAVE_AS_ZERO_ERROR_FREE]
- check_if_contains_only_one_element(save_as_zero_error_free, OtherId.SAVE_AS_ZERO_ERROR_FREE)
- save_as_zero_error_free = save_as_zero_error_free[-1]
- self._save_builder.set_zero_free_correction(save_as_zero_error_free)
-
- if OtherId.USER_SPECIFIED_OUTPUT_NAME in user_file_items:
- user_specified_output_name = user_file_items[OtherId.USER_SPECIFIED_OUTPUT_NAME]
- check_if_contains_only_one_element(user_specified_output_name, OtherId.USER_SPECIFIED_OUTPUT_NAME)
- user_specified_output_name = user_specified_output_name[-1]
- self._save_builder.set_user_specified_output_name(user_specified_output_name)
-
- if OtherId.USER_SPECIFIED_OUTPUT_NAME_SUFFIX in user_file_items:
- user_specified_output_name_suffix = user_file_items[OtherId.USER_SPECIFIED_OUTPUT_NAME_SUFFIX]
- check_if_contains_only_one_element(user_specified_output_name_suffix,
- OtherId.USER_SPECIFIED_OUTPUT_NAME_SUFFIX)
- user_specified_output_name_suffix = user_specified_output_name_suffix[-1]
- self._save_builder.set_user_specified_output_name_suffix(user_specified_output_name_suffix)
-
- if OtherId.USE_REDUCTION_MODE_AS_SUFFIX in user_file_items:
- use_reduction_mode_as_suffix = user_file_items[OtherId.USE_REDUCTION_MODE_AS_SUFFIX]
- check_if_contains_only_one_element(use_reduction_mode_as_suffix,
- OtherId.USE_REDUCTION_MODE_AS_SUFFIX)
- use_reduction_mode_as_suffix = use_reduction_mode_as_suffix[-1]
- self._save_builder.set_use_reduction_mode_as_suffix(use_reduction_mode_as_suffix)
-
- def _add_information_to_data_state(self, user_file_items):
- # The only thing that should be set on the data is the tube calibration file which is specified in
- # the user file.
- if TubeCalibrationFileId.FILE in user_file_items:
- tube_calibration = user_file_items[TubeCalibrationFileId.FILE]
- check_if_contains_only_one_element(tube_calibration, TubeCalibrationFileId.FILE)
- tube_calibration = tube_calibration[-1]
- self._data.calibration = tube_calibration
-
- def convert_pos1(self, pos1):
- """
- Performs a conversion of position 1 of the beam centre. This is forwarded to the move builder.
-
- :param pos1: the first position (this can be x in mm or for LARMOR and angle)
- :return: the correctly scaled position
- """
- return self._move_builder.convert_pos1(pos1)
-
- def convert_pos2(self, pos2):
- """
- Performs a conversion of position 2 of the beam centre. This is forwarded to the move builder.
-
- :param pos2: the second position
- :return: the correctly scaled position
- """
- return self._move_builder.convert_pos2(pos2)
diff --git a/scripts/SANS/sans/user_file/txt_parsers/CommandInterfaceAdapter.py b/scripts/SANS/sans/user_file/txt_parsers/CommandInterfaceAdapter.py
new file mode 100644
index 0000000000000000000000000000000000000000..a2e1f1ca534525049339c082b850faab267afb66
--- /dev/null
+++ b/scripts/SANS/sans/user_file/txt_parsers/CommandInterfaceAdapter.py
@@ -0,0 +1,16 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+from sans.user_file.txt_parsers.ParsedDictConverter import ParsedDictConverter
+
+
+class CommandInterfaceAdapter(ParsedDictConverter):
+ def __init__(self, data_info, processed_state, ):
+ super(CommandInterfaceAdapter, self).__init__(data_info=data_info)
+ self._processed_state = processed_state
+
+ def _get_input_dict(self):
+ return self._processed_state
diff --git a/scripts/SANS/sans/user_file/txt_parsers/ParsedDictConverter.py b/scripts/SANS/sans/user_file/txt_parsers/ParsedDictConverter.py
new file mode 100644
index 0000000000000000000000000000000000000000..ce8b1f8ecb2b75e4a2b8b13eb4a17fed6f6884c2
--- /dev/null
+++ b/scripts/SANS/sans/user_file/txt_parsers/ParsedDictConverter.py
@@ -0,0 +1,1102 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+import abc
+import collections
+
+from sans.common.enums import DetectorType, RangeStepType, RebinType, FitType, DataType, FitModeForMerge
+from sans.common.general_functions import get_ranges_from_event_slice_setting, get_ranges_for_rebin_setting, \
+ get_ranges_for_rebin_array
+from sans.state.IStateParser import IStateParser
+from sans.state.StateObjects.StateAdjustment import StateAdjustment
+from sans.state.StateObjects.StateCalculateTransmission import get_calculate_transmission_builder
+from sans.state.StateObjects.StateCompatibility import StateCompatibility
+from sans.state.StateObjects.StateConvertToQ import StateConvertToQ
+from sans.state.StateObjects.StateData import StateData
+from sans.state.StateObjects.StateMaskDetectors import get_mask_builder
+from sans.state.StateObjects.StateMoveDetectors import get_move_builder
+from sans.state.StateObjects.StateNormalizeToMonitor import get_normalize_to_monitor_builder
+from sans.state.StateObjects.StateReductionMode import get_reduction_mode_builder
+from sans.state.StateObjects.StateSave import StateSave
+from sans.state.StateObjects.StateScale import StateScale
+from sans.state.StateObjects.StateSliceEvent import StateSliceEvent
+from sans.state.StateObjects.StateWavelength import StateWavelength
+from sans.state.StateObjects.StateWavelengthAndPixelAdjustment import StateWavelengthAndPixelAdjustment
+from sans.user_file.settings_tags import TubeCalibrationFileId, MaskId, LimitsId, complex_range, GravityId, \
+ QResolutionId, OtherId, MonId, TransId, FitId, BackId, SampleId, SetId, DetectorId, simple_range, \
+ rebin_string_values
+
+
+class ParsedDictConverter(IStateParser):
+ def __init__(self, data_info):
+ super(ParsedDictConverter, self).__init__()
+ self._cached_result = None
+ self._data_info = data_info
+
+ @property
+ def _input_dict(self):
+ if not self._cached_result:
+ self._cached_result = self._get_input_dict()
+ # Ensure we always have a dict
+ self._cached_result = self._cached_result if self._cached_result else {}
+ return self._cached_result
+
+ @abc.abstractmethod
+ def _get_input_dict(self): # -> dict:
+ """
+ Gets the dictionary to translate as an input dictionary from the inheriting adapter
+ :return: Dictionary to translate
+ """
+ pass
+
+ def get_state_adjustment(self): # -> StateAdjustment:
+ state = StateAdjustment()
+ # Get the wide angle correction setting
+ self._set_single_entry(state, "wide_angle_correction", SampleId.PATH)
+
+ state.calculate_transmission = self.get_state_calculate_transmission()
+ state.normalize_to_monitor = self.get_state_normalize_to_monitor()
+ state.wavelength_and_pixel_adjustment = self.get_state_wavelength_and_pixel_adjustment()
+
+ return state
+
+ def get_state_calculate_transmission(self): # -> StateCalculateTransmission:
+ state_builder = get_calculate_transmission_builder(data_info=self._data_info)
+
+ self._set_single_entry(state_builder.state, "transmission_radius_on_detector", TransId.RADIUS,
+ apply_to_value=_convert_mm_to_m)
+
+ # List of transmission roi files
+ if TransId.ROI in self._input_dict:
+ trans_roi = self._input_dict[TransId.ROI]
+ state_builder.set_transmission_roi_files(trans_roi)
+
+ # List of transmission mask files
+ if TransId.MASK in self._input_dict:
+ trans_mask = self._input_dict[TransId.MASK]
+ state_builder.set_transmission_mask_files(trans_mask)
+
+ # The prompt peak correction values
+ _set_prompt_peak_correction(state_builder.state, self._input_dict)
+
+ # The transmission spectrum
+ if TransId.SPEC in self._input_dict:
+ trans_spec = self._input_dict[TransId.SPEC]
+ trans_spec = trans_spec[-1]
+ state_builder.set_transmission_monitor(trans_spec)
+
+ # The incident monitor spectrum for transmission calculation
+ if MonId.SPECTRUM in self._input_dict:
+ mon_spectrum = self._input_dict[MonId.SPECTRUM]
+ mon_spec = [spec for spec in mon_spectrum if spec.is_trans]
+ if mon_spec:
+ mon_spec = mon_spec[-1]
+ rebin_type = RebinType.INTERPOLATING_REBIN if mon_spec.interpolate else RebinType.REBIN
+ state_builder.set_rebin_type(rebin_type)
+
+ # We have to check if the spectrum is None, this can be the case when the user wants to use the
+ # default incident monitor spectrum
+ if mon_spec.spectrum:
+ state_builder.set_incident_monitor(mon_spec.spectrum)
+
+ # The general background settings
+ _set_background_tof_general(state_builder.state, self._input_dict)
+
+ # The monitor-specific background settings
+ _set_background_tof_monitor(state_builder.state, self._input_dict)
+
+ # The roi-specific background settings
+ if BackId.TRANS in self._input_dict:
+ back_trans = self._input_dict[BackId.TRANS]
+ back_trans = back_trans[-1]
+ state_builder.set_background_TOF_roi_start(back_trans.start)
+ state_builder.set_background_TOF_roi_stop(back_trans.stop)
+
+ # Set the fit settings
+ if FitId.GENERAL in self._input_dict:
+ fit_general = self._input_dict[FitId.GENERAL]
+ # We can have settings for both the sample or the can or individually
+ # There can be three types of settings:
+ # 1. Clearing the fit setting
+ # 2. General settings where the entry data_type is not specified. Settings apply to both sample and can
+ # 3. Sample settings
+ # 4. Can settings
+ # We first apply the general settings. Specialized settings for can or sample override the general settings
+ # As usual if there are multiple settings for a specific case, then the last in the list is used.
+
+ # 1 Fit type settings
+ clear_settings = [item for item in fit_general if item.data_type is None
+ and item.fit_type is FitType.NO_FIT]
+
+ if clear_settings:
+ clear_settings = clear_settings[-1]
+ # Will set the fitting to NoFit
+ state_builder.set_sample_fit_type(clear_settings.fit_type)
+ state_builder.set_can_fit_type(clear_settings.fit_type)
+
+ # 2. General settings
+ general_settings = [item for item in fit_general if item.data_type is None and
+ item.fit_type is not FitType.NO_FIT]
+ if general_settings:
+ general_settings = general_settings[-1]
+ state_builder.set_sample_fit_type(general_settings.fit_type)
+ state_builder.set_sample_polynomial_order(general_settings.polynomial_order)
+ state_builder.set_sample_wavelength_low(general_settings.start)
+ state_builder.set_sample_wavelength_high(general_settings.stop)
+ state_builder.set_can_fit_type(general_settings.fit_type)
+ state_builder.set_can_polynomial_order(general_settings.polynomial_order)
+ state_builder.set_can_wavelength_low(general_settings.start)
+ state_builder.set_can_wavelength_high(general_settings.stop)
+
+ # 3. Sample settings
+ sample_settings = [item for item in fit_general if item.data_type is DataType.SAMPLE]
+ if sample_settings:
+ sample_settings = sample_settings[-1]
+ state_builder.set_sample_fit_type(sample_settings.fit_type)
+ state_builder.set_sample_polynomial_order(sample_settings.polynomial_order)
+ state_builder.set_sample_wavelength_low(sample_settings.start)
+ state_builder.set_sample_wavelength_high(sample_settings.stop)
+
+ # 4. Can settings
+ can_settings = [item for item in fit_general if item.data_type is DataType.CAN]
+ if can_settings:
+ can_settings = can_settings[-1]
+ state_builder.set_can_fit_type(can_settings.fit_type)
+ state_builder.set_can_polynomial_order(can_settings.polynomial_order)
+ state_builder.set_can_wavelength_low(can_settings.start)
+ state_builder.set_can_wavelength_high(can_settings.stop)
+
+ # Set the wavelength default configuration
+ _set_wavelength_limits(state_builder.state, self._input_dict)
+
+ # Set the full wavelength range. Note that this can currently only be set from the ISISCommandInterface
+ if OtherId.USE_FULL_WAVELENGTH_RANGE in self._input_dict:
+ use_full_wavelength_range = self._input_dict[OtherId.USE_FULL_WAVELENGTH_RANGE]
+ use_full_wavelength_range = use_full_wavelength_range[-1]
+ state_builder.set_use_full_wavelength_range(use_full_wavelength_range)
+ state = state_builder.build()
+ return state
+
+ def get_state_compatibility(self): # -> StateCompatibility:
+ state = StateCompatibility()
+ if LimitsId.EVENTS_BINNING in self._input_dict:
+ events_binning = self._input_dict[LimitsId.EVENTS_BINNING]
+ events_binning = events_binning[-1]
+ state.time_rebin_string = events_binning
+
+ if OtherId.USE_COMPATIBILITY_MODE in self._input_dict:
+ use_compatibility_mode = self._input_dict[OtherId.USE_COMPATIBILITY_MODE]
+ use_compatibility_mode = use_compatibility_mode[-1]
+ state.use_compatibility_mode = use_compatibility_mode
+
+ if OtherId.USE_EVENT_SLICE_OPTIMISATION in self._input_dict:
+ use_event_slice_optimisation = self._input_dict[OtherId.USE_EVENT_SLICE_OPTIMISATION]
+ use_event_slice_optimisation = use_event_slice_optimisation[-1]
+ state.use_event_slice_optimisation = use_event_slice_optimisation
+
+ return state
+
+ def get_state_convert_to_q(self): # -> StateConvertToQ:
+ state = StateConvertToQ()
+ # Get the radius cut off if any is present
+ self._set_single_entry(state, "radius_cutoff", LimitsId.RADIUS_CUT, apply_to_value=_convert_mm_to_m)
+
+ # Get the wavelength cut off if any is present
+ self._set_single_entry(state, "wavelength_cutoff", LimitsId.WAVELENGTH_CUT)
+
+ # Get the 1D q values
+ if LimitsId.Q in self._input_dict:
+ limits_q = self._input_dict[LimitsId.Q]
+ limits_q = limits_q[-1]
+ state.q_min = limits_q.min
+ state.q_max = limits_q.max
+ state.q_1d_rebin_string = limits_q.rebin_string
+
+ # Get the 2D q values
+ if LimitsId.QXY in self._input_dict:
+ limits_qxy = self._input_dict[LimitsId.QXY]
+ limits_qxy = limits_qxy[-1]
+ # Now we have to check if we have a simple pattern or a more complex pattern at hand
+ is_complex = isinstance(limits_qxy, complex_range)
+ state.q_xy_max = limits_qxy.stop
+ if is_complex:
+ # Note that it has not been implemented in the old reducer, but the documentation is
+ # suggesting that it is available. Hence we throw here.
+ raise RuntimeError("Qxy cannot handle settings of type: L/Q l1,dl1,l3,dl2,l2 [/LIN|/LOG] ")
+ else:
+ state.q_xy_step = limits_qxy.step
+ state.q_xy_step_type = limits_qxy.step_type
+
+ # Get the Gravity settings
+ self._set_single_entry(state, "use_gravity", GravityId.ON_OFF)
+ self._set_single_entry(state, "gravity_extra_length", GravityId.EXTRA_LENGTH)
+
+ # Get the QResolution settings set_q_resolution_delta_r
+ self._set_single_entry(state, "use_q_resolution", QResolutionId.ON)
+ self._set_single_entry(state, "q_resolution_delta_r", QResolutionId.DELTA_R, apply_to_value=_convert_mm_to_m)
+ self._set_single_entry(state, "q_resolution_collimation_length", QResolutionId.COLLIMATION_LENGTH)
+ self._set_single_entry(state, "q_resolution_a1", QResolutionId.A1, apply_to_value=_convert_mm_to_m)
+ self._set_single_entry(state, "q_resolution_a2", QResolutionId.A2, apply_to_value=_convert_mm_to_m)
+ self._set_single_entry(state, "moderator_file", QResolutionId.MODERATOR)
+ self._set_single_entry(state, "q_resolution_h1", QResolutionId.H1, apply_to_value=_convert_mm_to_m)
+ self._set_single_entry(state, "q_resolution_h2", QResolutionId.H2, apply_to_value=_convert_mm_to_m)
+ self._set_single_entry(state, "q_resolution_w1", QResolutionId.W1, apply_to_value=_convert_mm_to_m)
+ self._set_single_entry(state, "q_resolution_w2", QResolutionId.W2, apply_to_value=_convert_mm_to_m)
+
+ # ------------------------
+ # Reduction Dimensionality
+ # ------------------------
+ self._set_single_entry(state, "reduction_dimensionality", OtherId.REDUCTION_DIMENSIONALITY)
+ return state
+
+ def get_state_data(self): # -> StateData:
+ assert isinstance(self._data_info, StateData)
+ state = self._data_info
+ # TODO ideally in the future we should move this to another state object as state Data is not from user files
+ tube_calib = _get_last_element(self._input_dict.get(TubeCalibrationFileId.FILE))
+ state.calibration = tube_calib
+ return state
+
+ # We have taken the implementation originally provided, so we can't help the complexity
+ def get_state_mask_detectors(self): # noqa: C901
+ state_builder = get_mask_builder(data_info=self._data_info)
+
+ if MaskId.LINE in self._input_dict:
+ mask_lines = self._input_dict[MaskId.LINE]
+ mask_line = mask_lines[-1]
+ # We need the width and the angle
+ angle = mask_line.angle
+ width = _convert_mm_to_m(mask_line.width)
+ # The position is already specified in meters in the user file
+ pos1 = mask_line.x
+ pos2 = mask_line.y
+ if angle is None or width is None:
+ raise RuntimeError("UserFileStateDirector: You specified a line mask without an angle or a width."
+ "The parameters were: width {0}; angle {1}; x {2}; y {3}".format(width, angle,
+ pos1, pos2))
+ pos1 = 0.0 if pos1 is None else pos1
+ pos2 = 0.0 if pos2 is None else pos2
+
+ state_builder.set_beam_stop_arm_width(width)
+ state_builder.set_beam_stop_arm_angle(angle)
+ state_builder.set_beam_stop_arm_pos1(pos1)
+ state_builder.set_beam_stop_arm_pos2(pos2)
+
+ # ---------------------------------
+ # 2. General time mask
+ # ---------------------------------
+ if MaskId.TIME in self._input_dict:
+ mask_time_general = self._input_dict[MaskId.TIME]
+ start_time = []
+ stop_time = []
+ for times in mask_time_general:
+ if times.start > times.start:
+ raise RuntimeError("UserFileStateDirector: You specified a general time mask with a start time {0}"
+ " which is larger than the stop time {1} of the mask. This is not"
+ " valid.".format(times.start, times.stop))
+ start_time.append(times.start)
+ stop_time.append(times.stop)
+ state_builder.set_bin_mask_general_start(start_time)
+ state_builder.set_bin_mask_general_stop(stop_time)
+
+ # ---------------------------------
+ # 3. Detector-bound time mask
+ # ---------------------------------
+ if MaskId.TIME_DETECTOR in self._input_dict:
+ mask_times = self._input_dict[MaskId.TIME_DETECTOR]
+ start_times_hab = []
+ stop_times_hab = []
+ start_times_lab = []
+ stop_times_lab = []
+ for times in mask_times:
+ if times.start > times.start:
+ raise RuntimeError("UserFileStateDirector: You specified a general time mask with a start time {0}"
+ " which is larger than the stop time {1} of the mask. This is not"
+ " valid.".format(times.start, times.stop))
+ if times.detector_type is DetectorType.HAB:
+ start_times_hab.append(times.start)
+ stop_times_hab.append(times.stop)
+ elif times.detector_type is DetectorType.LAB:
+ start_times_lab.append(times.start)
+ stop_times_lab.append(times.stop)
+ else:
+ RuntimeError("UserFileStateDirector: The specified detector {0} is not "
+ "known".format(times.detector_type))
+ if start_times_hab:
+ state_builder.set_HAB_bin_mask_start(start_times_hab)
+ if stop_times_hab:
+ state_builder.set_HAB_bin_mask_stop(stop_times_hab)
+ if start_times_lab:
+ state_builder.set_LAB_bin_mask_start(start_times_lab)
+ if stop_times_lab:
+ state_builder.set_LAB_bin_mask_stop(stop_times_lab)
+
+ # ---------------------------------
+ # 4. Clear detector
+ # ---------------------------------
+ if MaskId.CLEAR_DETECTOR_MASK in self._input_dict:
+ clear_detector_mask = self._input_dict[MaskId.CLEAR_DETECTOR_MASK]
+ # We select the entry which was added last.
+ clear_detector_mask = clear_detector_mask[-1]
+ state_builder.set_clear(clear_detector_mask)
+
+ # ---------------------------------
+ # 5. Clear time
+ # ---------------------------------
+ if MaskId.CLEAR_TIME_MASK in self._input_dict:
+ clear_time_mask = self._input_dict[MaskId.CLEAR_TIME_MASK]
+ # We select the entry which was added last.
+ clear_time_mask = clear_time_mask[-1]
+ state_builder.set_clear_time(clear_time_mask)
+
+ # ---------------------------------
+ # 6. Single Spectrum
+ # ---------------------------------
+ if MaskId.SINGLE_SPECTRUM_MASK in self._input_dict:
+ single_spectra = self._input_dict[MaskId.SINGLE_SPECTRUM_MASK]
+ # Note that we are using an unusual setter here. Check mask.py for why we are doing this.
+ state_builder.set_single_spectra_on_detector(single_spectra)
+
+ # ---------------------------------
+ # 7. Spectrum Range
+ # ---------------------------------
+ if MaskId.SPECTRUM_RANGE_MASK in self._input_dict:
+ spectrum_ranges = self._input_dict[MaskId.SPECTRUM_RANGE_MASK]
+ start_range = []
+ stop_range = []
+ for spectrum_range in spectrum_ranges:
+ if spectrum_range.start > spectrum_range.start:
+ raise RuntimeError("UserFileStateDirector: You specified a spectrum range with a start value {0}"
+ " which is larger than the stop value {1}. This is not"
+ " valid.".format(spectrum_range.start, spectrum_range.stop))
+ start_range.append(spectrum_range.start)
+ stop_range.append(spectrum_range.stop)
+ # Note that we are using an unusual setter here. Check mask.py for why we are doing this.
+ state_builder.set_spectrum_range_on_detector(start_range, stop_range)
+
+ # ---------------------------------
+ # 8. Vertical single strip
+ # ---------------------------------
+ if MaskId.VERTICAL_SINGLE_STRIP_MASK in self._input_dict:
+ single_vertical_strip_masks = self._input_dict[MaskId.VERTICAL_SINGLE_STRIP_MASK]
+ entry_hab = []
+ entry_lab = []
+ for single_vertical_strip_mask in single_vertical_strip_masks:
+ if single_vertical_strip_mask.detector_type is DetectorType.HAB:
+ entry_hab.append(single_vertical_strip_mask.entry)
+ elif single_vertical_strip_mask.detector_type is DetectorType.LAB:
+ entry_lab.append(single_vertical_strip_mask.entry)
+ else:
+ raise RuntimeError("UserFileStateDirector: The vertical single strip mask {0} has an unknown "
+ "detector {1} associated"
+ " with it.".format(single_vertical_strip_mask.entry,
+ single_vertical_strip_mask.detector_type))
+ if entry_hab:
+ state_builder.set_HAB_single_vertical_strip_mask(entry_hab)
+ if entry_lab:
+ state_builder.set_LAB_single_vertical_strip_mask(entry_lab)
+
+ # ---------------------------------
+ # 9. Vertical range strip
+ # ---------------------------------
+ if MaskId.VERTICAL_RANGE_STRIP_MASK in self._input_dict:
+ range_vertical_strip_masks = self._input_dict[MaskId.VERTICAL_RANGE_STRIP_MASK]
+ start_hab = []
+ stop_hab = []
+ start_lab = []
+ stop_lab = []
+ for range_vertical_strip_mask in range_vertical_strip_masks:
+ if range_vertical_strip_mask.detector_type is DetectorType.HAB:
+ start_hab.append(range_vertical_strip_mask.start)
+ stop_hab.append(range_vertical_strip_mask.stop)
+ elif range_vertical_strip_mask.detector_type is DetectorType.LAB:
+ start_lab.append(range_vertical_strip_mask.start)
+ stop_lab.append(range_vertical_strip_mask.stop)
+ else:
+ raise RuntimeError("UserFileStateDirector: The vertical range strip mask {0} has an unknown "
+ "detector {1} associated "
+ "with it.".format(range_vertical_strip_mask.entry,
+ range_vertical_strip_mask.detector_type))
+ if start_hab:
+ state_builder.set_HAB_range_vertical_strip_start(start_hab)
+ if stop_hab:
+ state_builder.set_HAB_range_vertical_strip_stop(stop_hab)
+ if start_lab:
+ state_builder.set_LAB_range_vertical_strip_start(start_lab)
+ if stop_lab:
+ state_builder.set_LAB_range_vertical_strip_stop(stop_lab)
+
+ # ---------------------------------
+ # 10. Horizontal single strip
+ # ---------------------------------
+ if MaskId.HORIZONTAL_SINGLE_STRIP_MASK in self._input_dict:
+ single_horizontal_strip_masks = self._input_dict[MaskId.HORIZONTAL_SINGLE_STRIP_MASK]
+ entry_hab = []
+ entry_lab = []
+ for single_horizontal_strip_mask in single_horizontal_strip_masks:
+ if single_horizontal_strip_mask.detector_type is DetectorType.HAB:
+ entry_hab.append(single_horizontal_strip_mask.entry)
+ elif single_horizontal_strip_mask.detector_type is DetectorType.LAB:
+ entry_lab.append(single_horizontal_strip_mask.entry)
+ else:
+ raise RuntimeError("UserFileStateDirector: The horizontal single strip mask {0} has an unknown "
+ "detector {1} associated"
+ " with it.".format(single_horizontal_strip_mask.entry,
+ single_horizontal_strip_mask.detector_type))
+ if entry_hab:
+ state_builder.set_HAB_single_horizontal_strip_mask(entry_hab)
+ if entry_lab:
+ state_builder.set_LAB_single_horizontal_strip_mask(entry_lab)
+
+ # ---------------------------------
+ # 11. Horizontal range strip
+ # ---------------------------------
+ if MaskId.HORIZONTAL_RANGE_STRIP_MASK in self._input_dict:
+ range_horizontal_strip_masks = self._input_dict[MaskId.HORIZONTAL_RANGE_STRIP_MASK]
+ start_hab = []
+ stop_hab = []
+ start_lab = []
+ stop_lab = []
+ for range_horizontal_strip_mask in range_horizontal_strip_masks:
+ if range_horizontal_strip_mask.detector_type is DetectorType.HAB:
+ start_hab.append(range_horizontal_strip_mask.start)
+ stop_hab.append(range_horizontal_strip_mask.stop)
+ elif range_horizontal_strip_mask.detector_type is DetectorType.LAB:
+ start_lab.append(range_horizontal_strip_mask.start)
+ stop_lab.append(range_horizontal_strip_mask.stop)
+ else:
+ raise RuntimeError("UserFileStateDirector: The vertical range strip mask {0} has an unknown "
+ "detector {1} associated "
+ "with it.".format(range_horizontal_strip_mask.entry,
+ range_horizontal_strip_mask.detector_type))
+ if start_hab:
+ state_builder.set_HAB_range_horizontal_strip_start(start_hab)
+ if stop_hab:
+ state_builder.set_HAB_range_horizontal_strip_stop(stop_hab)
+ if start_lab:
+ state_builder.set_LAB_range_horizontal_strip_start(start_lab)
+ if stop_lab:
+ state_builder.set_LAB_range_horizontal_strip_stop(stop_lab)
+
+ # ---------------------------------
+ # 12. Block
+ # ---------------------------------
+ if MaskId.BLOCK in self._input_dict:
+ blocks = self._input_dict[MaskId.BLOCK]
+ horizontal_start_hab = []
+ horizontal_stop_hab = []
+ vertical_start_hab = []
+ vertical_stop_hab = []
+ horizontal_start_lab = []
+ horizontal_stop_lab = []
+ vertical_start_lab = []
+ vertical_stop_lab = []
+
+ for block in blocks:
+ if block.horizontal1 > block.horizontal2 or block.vertical1 > block.vertical2:
+ raise RuntimeError("UserFileStateDirector: The block mask seems to have inconsistent entries. "
+ "The values are horizontal_start {0}; horizontal_stop {1}; vertical_start {2};"
+ " vertical_stop {3}".format(block.horizontal1, block.horizontal2,
+ block.vertical1, block.vertical2))
+ if block.detector_type is DetectorType.HAB:
+ horizontal_start_hab.append(block.horizontal1)
+ horizontal_stop_hab.append(block.horizontal2)
+ vertical_start_hab.append(block.vertical1)
+ vertical_stop_hab.append(block.vertical2)
+ elif block.detector_type is DetectorType.LAB:
+ horizontal_start_lab.append(block.horizontal1)
+ horizontal_stop_lab.append(block.horizontal2)
+ vertical_start_lab.append(block.vertical1)
+ vertical_stop_lab.append(block.vertical2)
+ else:
+ raise RuntimeError("UserFileStateDirector: The block mask has an unknown "
+ "detector {0} associated "
+ "with it.".format(block.detector_type))
+ if horizontal_start_hab:
+ state_builder.set_HAB_block_horizontal_start(horizontal_start_hab)
+ if horizontal_stop_hab:
+ state_builder.set_HAB_block_horizontal_stop(horizontal_stop_hab)
+ if vertical_start_lab:
+ state_builder.set_LAB_block_vertical_start(vertical_start_lab)
+ if vertical_stop_lab:
+ state_builder.set_LAB_block_vertical_stop(vertical_stop_lab)
+
+ # ---------------------------------
+ # 13. Block cross
+ # ---------------------------------
+ if MaskId.BLOCK_CROSS in self._input_dict:
+ block_crosses = self._input_dict[MaskId.BLOCK_CROSS]
+ horizontal_hab = []
+ vertical_hab = []
+ horizontal_lab = []
+ vertical_lab = []
+ for block_cross in block_crosses:
+ if block_cross.detector_type is DetectorType.HAB:
+ horizontal_hab.append(block_cross.horizontal)
+ vertical_hab.append(block_cross.vertical)
+ elif block_cross.detector_type is DetectorType.LAB:
+ horizontal_lab.append(block_cross.horizontal)
+ vertical_lab.append(block_cross.vertical)
+ else:
+ raise RuntimeError("UserFileStateDirector: The block cross mask has an unknown "
+ "detector {0} associated "
+ "with it.".format(block_cross.detector_type))
+ if horizontal_hab:
+ state_builder.set_HAB_block_cross_horizontal(horizontal_hab)
+ if vertical_hab:
+ state_builder.set_HAB_block_cross_vertical(vertical_hab)
+ if horizontal_lab:
+ state_builder.set_LAB_block_cross_horizontal(horizontal_lab)
+ if vertical_lab:
+ state_builder.set_LAB_block_cross_vertical(vertical_lab)
+
+ # ------------------------------------------------------------
+ # 14. Angles --> they are specified in L/Phi
+ # -----------------------------------------------------------
+ if LimitsId.ANGLE in self._input_dict:
+ angles = self._input_dict[LimitsId.ANGLE]
+ # Should the user have chosen several values, then the last element is selected
+ angle = angles[-1]
+ state_builder.set_phi_min(angle.min)
+ state_builder.set_phi_max(angle.max)
+ state_builder.set_use_mask_phi_mirror(angle.use_mirror)
+
+ # ------------------------------------------------------------
+ # 15. Maskfiles
+ # -----------------------------------------------------------
+ if MaskId.FILE in self._input_dict:
+ mask_files = self._input_dict[MaskId.FILE]
+ state_builder.set_mask_files(mask_files)
+
+ # ------------------------------------------------------------
+ # 16. Radius masks
+ # -----------------------------------------------------------
+ if LimitsId.RADIUS in self._input_dict:
+ radii = self._input_dict[LimitsId.RADIUS]
+ # Should the user have chosen several values, then the last element is selected
+ radius = radii[-1]
+ if radius.start > radius.stop > 0:
+ raise RuntimeError("UserFileStateDirector: The inner radius {0} appears to be larger that the outer"
+ " radius {1} of the mask.".format(radius.start, radius.stop))
+ min_value = None if radius.start is None else _convert_mm_to_m(radius.start)
+ max_value = None if radius.stop is None else _convert_mm_to_m(radius.stop)
+ state_builder.set_radius_min(min_value)
+ state_builder.set_radius_max(max_value)
+ return state_builder.build()
+
+ # We have taken the implementation originally provided, so we can't help the complexity
+ def get_state_move_detectors(self): # noqa : C901
+ state_builder = get_move_builder(data_info=self._data_info)
+
+ if DetectorId.CORRECTION_X in self._input_dict:
+ corrections_in_x = self._input_dict[DetectorId.CORRECTION_X]
+ for correction_x in corrections_in_x:
+ if correction_x.detector_type is DetectorType.HAB:
+ state_builder.set_HAB_x_translation_correction(_convert_mm_to_m(correction_x.entry))
+ elif correction_x.detector_type is DetectorType.LAB:
+ state_builder.set_LAB_x_translation_correction(_convert_mm_to_m(correction_x.entry))
+ else:
+ raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
+ " x correction.".format(correction_x.detector_type))
+
+ if DetectorId.CORRECTION_Y in self._input_dict:
+ corrections_in_y = self._input_dict[DetectorId.CORRECTION_Y]
+ for correction_y in corrections_in_y:
+ if correction_y.detector_type is DetectorType.HAB:
+ state_builder.set_HAB_y_translation_correction(_convert_mm_to_m(correction_y.entry))
+ elif correction_y.detector_type is DetectorType.LAB:
+ state_builder.set_LAB_y_translation_correction(_convert_mm_to_m(correction_y.entry))
+ else:
+ raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
+ " y correction.".format(correction_y.detector_type))
+
+ if DetectorId.CORRECTION_Z in self._input_dict:
+ corrections_in_z = self._input_dict[DetectorId.CORRECTION_Z]
+ for correction_z in corrections_in_z:
+ if correction_z.detector_type is DetectorType.HAB:
+ state_builder.set_HAB_z_translation_correction(_convert_mm_to_m(correction_z.entry))
+ elif correction_z.detector_type is DetectorType.LAB:
+ state_builder.set_LAB_z_translation_correction(_convert_mm_to_m(correction_z.entry))
+ else:
+ raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
+ " z correction.".format(correction_z.detector_type))
+
+ # ---------------------------
+ # Correction for Rotation
+ # ---------------------------
+ if DetectorId.CORRECTION_ROTATION in self._input_dict:
+ rotation_correction = self._input_dict[DetectorId.CORRECTION_ROTATION]
+ rotation_correction = rotation_correction[-1]
+ if rotation_correction.detector_type is DetectorType.HAB:
+ state_builder.set_HAB_rotation_correction(rotation_correction.entry)
+ elif rotation_correction.detector_type is DetectorType.LAB:
+ state_builder.set_LAB_rotation_correction(rotation_correction.entry)
+ else:
+ raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
+ " rotation correction.".format(rotation_correction.detector_type))
+
+ # ---------------------------
+ # Correction for Radius
+ # ---------------------------
+ if DetectorId.CORRECTION_RADIUS in self._input_dict:
+ radius_corrections = self._input_dict[DetectorId.CORRECTION_RADIUS]
+ for radius_correction in radius_corrections:
+ if radius_correction.detector_type is DetectorType.HAB:
+ state_builder.set_HAB_radius_correction(_convert_mm_to_m(radius_correction.entry))
+ elif radius_correction.detector_type is DetectorType.LAB:
+ state_builder.set_LAB_radius_correction(_convert_mm_to_m(radius_correction.entry))
+ else:
+ raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
+ " radius correction.".format(radius_correction.detector_type))
+
+ # ---------------------------
+ # Correction for Translation
+ # ---------------------------
+ if DetectorId.CORRECTION_TRANSLATION in self._input_dict:
+ side_corrections = self._input_dict[DetectorId.CORRECTION_TRANSLATION]
+ for side_correction in side_corrections:
+ if side_correction.detector_type is DetectorType.HAB:
+ state_builder.set_HAB_side_correction(_convert_mm_to_m(side_correction.entry))
+ elif side_correction.detector_type is DetectorType.LAB:
+ state_builder.set_LAB_side_correction(_convert_mm_to_m(side_correction.entry))
+ else:
+ raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
+ " side correction.".format(side_correction.detector_type))
+
+ # ---------------------------
+ # Tilt
+ # ---------------------------
+ if DetectorId.CORRECTION_X_TILT in self._input_dict:
+ tilt_correction = self._input_dict[DetectorId.CORRECTION_X_TILT]
+ tilt_correction = tilt_correction[-1]
+ if tilt_correction.detector_type is DetectorType.HAB:
+ state_builder.set_HAB_x_tilt_correction(tilt_correction.entry)
+ elif tilt_correction.detector_type is DetectorType.LAB:
+ state_builder.set_LAB_side_correction(tilt_correction.entry)
+ else:
+ raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
+ " titlt correction.".format(tilt_correction.detector_type))
+
+ if DetectorId.CORRECTION_Y_TILT in self._input_dict:
+ tilt_correction = self._input_dict[DetectorId.CORRECTION_Y_TILT]
+ tilt_correction = tilt_correction[-1]
+ if tilt_correction.detector_type is DetectorType.HAB:
+ state_builder.set_HAB_y_tilt_correction(tilt_correction.entry)
+ elif tilt_correction.detector_type is DetectorType.LAB:
+ state_builder.set_LAB_side_correction(tilt_correction.entry)
+ else:
+ raise RuntimeError("UserFileStateDirector: An unknown detector {0} was used for the"
+ " tilt correction.".format(tilt_correction.detector_type))
+
+ # ---------------------------
+ # Sample offset
+ # ---------------------------
+ self._set_single_entry(state_builder.state, "sample_offset", SampleId.OFFSET, apply_to_value=_convert_mm_to_m)
+
+ # ---------------------------
+ # Monitor offsets
+ # ---------------------------
+
+ def parse_shift(key_to_parse, spec_num):
+ monitor_n_shift = self._input_dict[key_to_parse]
+ # Should the user have chosen several values, then the last element is selected
+ monitor_n_shift = monitor_n_shift[-1]
+
+ # Determine if the object has the set_monitor_X_offset method
+ set_monitor_4_offset = getattr(state_builder, "set_monitor_4_offset", dict())
+ set_monitor_5_offset = getattr(state_builder, "set_monitor_5_offset", dict())
+
+ if spec_num == 4 and isinstance(set_monitor_4_offset, collections.Callable):
+ state_builder.set_monitor_4_offset(_convert_mm_to_m(monitor_n_shift))
+ elif spec_num == 5 and isinstance(set_monitor_5_offset, collections.Callable):
+ state_builder.set_monitor_5_offset(_convert_mm_to_m(monitor_n_shift))
+
+ if TransId.SPEC_4_SHIFT in self._input_dict:
+ parse_shift(key_to_parse=TransId.SPEC_4_SHIFT, spec_num=4)
+
+ if TransId.SPEC_5_SHIFT in self._input_dict:
+ parse_shift(key_to_parse=TransId.SPEC_5_SHIFT, spec_num=5)
+
+ # ---------------------------
+ # Beam Centre, this can be for HAB and LAB
+ # ---------------------------
+ if SetId.CENTRE in self._input_dict:
+ beam_centres = self._input_dict[SetId.CENTRE]
+ beam_centres_for_hab = [beam_centre for beam_centre in beam_centres if beam_centre.detector_type
+ is DetectorType.HAB]
+ beam_centres_for_lab = [beam_centre for beam_centre in beam_centres if beam_centre.detector_type
+ is DetectorType.LAB]
+ for beam_centre in beam_centres_for_lab:
+ pos1 = beam_centre.pos1
+ pos2 = beam_centre.pos2
+ state_builder.set_LAB_sample_centre_pos1(state_builder.convert_pos1(pos1))
+ state_builder.set_LAB_sample_centre_pos2(state_builder.convert_pos2(pos2))
+ if hasattr(state_builder, "set_HAB_sample_centre_pos1"):
+ state_builder.set_HAB_sample_centre_pos1(state_builder.convert_pos1(pos1))
+ if hasattr(state_builder, "set_HAB_sample_centre_pos2"):
+ state_builder.set_HAB_sample_centre_pos2(state_builder.convert_pos2(pos2))
+
+ for beam_centre in beam_centres_for_hab:
+ pos1 = beam_centre.pos1
+ pos2 = beam_centre.pos2
+ state_builder.set_HAB_sample_centre_pos1(state_builder.convert_pos1(pos1))
+ state_builder.set_HAB_sample_centre_pos2(state_builder.convert_pos2(pos2))
+
+ return state_builder.build()
+
+ def get_state_normalize_to_monitor(self): # -> StateNormalizeToMonitor:
+ builder = get_normalize_to_monitor_builder(self._data_info)
+ state = builder.state
+ # Extract the incident monitor and which type of rebinning to use (interpolating or normal)
+ if MonId.SPECTRUM in self._input_dict:
+ mon_spectrum = self._input_dict[MonId.SPECTRUM]
+ mon_spec = [spec for spec in mon_spectrum if not spec.is_trans]
+
+ if mon_spec:
+ mon_spec = mon_spec[-1]
+ rebin_type = RebinType.INTERPOLATING_REBIN if mon_spec.interpolate else RebinType.REBIN
+ state.rebin_type = rebin_type
+
+ # We have to check if the spectrum is None, this can be the case when the user wants to use the
+ # default incident monitor spectrum
+ if mon_spec.spectrum:
+ state.incident_monitor = mon_spec.spectrum
+
+ # The prompt peak correction values
+ _set_prompt_peak_correction(state, self._input_dict)
+
+ # The general background settings
+ _set_background_tof_general(state, self._input_dict)
+
+ # The monitor-specific background settings
+ _set_background_tof_monitor(state, self._input_dict)
+
+ # Get the wavelength rebin settings
+ _set_wavelength_limits(state, self._input_dict)
+ return builder.build()
+
+ # We have taken the implementation originally provided, so we can't help the complexity
+ def get_state_reduction_mode(self): # noqa: C901
+ # TODO this state builder should be removed, by simply moving the detector/IDF processing to state Data
+ state_builder = get_reduction_mode_builder(self._data_info)
+ self._set_single_entry(state_builder.state, "reduction_mode", DetectorId.REDUCTION_MODE)
+
+ # -------------------------------
+ # Shift and rescale
+ # -------------------------------
+ self._set_single_entry(state_builder.state, "merge_scale", DetectorId.RESCALE)
+ self._set_single_entry(state_builder.state, "merge_shift", DetectorId.SHIFT)
+
+ # -------------------------------
+ # User masking
+ # -------------------------------
+ merge_min = None
+ merge_max = None
+ merge_mask = False
+ if DetectorId.MERGE_RANGE in self._input_dict:
+ merge_range = self._input_dict[DetectorId.MERGE_RANGE]
+ merge_range = merge_range[-1]
+ merge_min = merge_range.start
+ merge_max = merge_range.stop
+ merge_mask = merge_range.use_fit
+
+ state_builder.set_merge_mask(merge_mask)
+ state_builder.set_merge_min(merge_min)
+ state_builder.set_merge_max(merge_max)
+
+ # -------------------------------
+ # Fitting merged
+ # -------------------------------
+ q_range_min_scale = None
+ q_range_max_scale = None
+ has_rescale_fit = False
+ if DetectorId.RESCALE_FIT in self._input_dict:
+ rescale_fits = self._input_dict[DetectorId.RESCALE_FIT]
+ rescale_fit = rescale_fits[-1]
+ q_range_min_scale = rescale_fit.start
+ q_range_max_scale = rescale_fit.stop
+ has_rescale_fit = rescale_fit.use_fit
+
+ q_range_min_shift = None
+ q_range_max_shift = None
+ has_shift_fit = False
+ if DetectorId.SHIFT_FIT in self._input_dict:
+ shift_fits = self._input_dict[DetectorId.SHIFT_FIT]
+ shift_fit = shift_fits[-1]
+ q_range_min_shift = shift_fit.start
+ q_range_max_shift = shift_fit.stop
+ has_shift_fit = shift_fit.use_fit
+
+ def get_min_q_boundary(min_q1, min_q2):
+ if not min_q1 and min_q2:
+ val = min_q2
+ elif min_q1 and not min_q2:
+ val = min_q1
+ elif not min_q1 and not min_q2:
+ val = None
+ else:
+ val = max(min_q1, min_q2)
+ return val
+
+ def get_max_q_boundary(max_q1, max_q2):
+ if not max_q1 and max_q2:
+ val = max_q2
+ elif max_q1 and not max_q2:
+ val = max_q1
+ elif not max_q1 and not max_q2:
+ val = None
+ else:
+ val = min(max_q1, max_q2)
+ return val
+
+ if has_rescale_fit and has_shift_fit:
+ state_builder.set_merge_fit_mode(FitModeForMerge.BOTH)
+ min_q = get_min_q_boundary(q_range_min_scale, q_range_min_shift)
+ max_q = get_max_q_boundary(q_range_max_scale, q_range_max_shift)
+ if min_q:
+ state_builder.set_merge_range_min(min_q)
+ if max_q:
+ state_builder.set_merge_range_max(max_q)
+ elif has_rescale_fit and not has_shift_fit:
+ state_builder.set_merge_fit_mode(FitModeForMerge.SCALE_ONLY)
+ if q_range_min_scale:
+ state_builder.set_merge_range_min(q_range_min_scale)
+ if q_range_max_scale:
+ state_builder.set_merge_range_max(q_range_max_scale)
+ elif not has_rescale_fit and has_shift_fit:
+ state_builder.set_merge_fit_mode(FitModeForMerge.SHIFT_ONLY)
+ if q_range_min_shift:
+ state_builder.set_merge_range_min(q_range_min_shift)
+ if q_range_max_shift:
+ state_builder.set_merge_range_max(q_range_max_shift)
+ else:
+ state_builder.set_merge_fit_mode(FitModeForMerge.NO_FIT)
+
+ # ------------------------
+ # Reduction Dimensionality
+ # ------------------------
+ self._set_single_entry(state_builder.state, "reduction_dimensionality", OtherId.REDUCTION_DIMENSIONALITY)
+ return state_builder.build()
+
+ def get_state_save(self): # -> StateSave:
+ state = StateSave()
+ if OtherId.SAVE_TYPES in self._input_dict:
+ save_types = self._input_dict[OtherId.SAVE_TYPES]
+ save_types = save_types[-1]
+ state.file_format = save_types
+
+ if OtherId.SAVE_AS_ZERO_ERROR_FREE in self._input_dict:
+ save_as_zero_error_free = self._input_dict[OtherId.SAVE_AS_ZERO_ERROR_FREE]
+ save_as_zero_error_free = save_as_zero_error_free[-1]
+ state.zero_free_correction = save_as_zero_error_free
+
+ if OtherId.USER_SPECIFIED_OUTPUT_NAME in self._input_dict:
+ user_specified_output_name = self._input_dict[OtherId.USER_SPECIFIED_OUTPUT_NAME]
+ user_specified_output_name = user_specified_output_name[-1]
+ state.user_specified_output_name = user_specified_output_name
+
+ if OtherId.USER_SPECIFIED_OUTPUT_NAME_SUFFIX in self._input_dict:
+ user_specified_output_name_suffix = self._input_dict[OtherId.USER_SPECIFIED_OUTPUT_NAME_SUFFIX]
+ user_specified_output_name_suffix = user_specified_output_name_suffix[-1]
+ state.user_specified_output_name_suffix = user_specified_output_name_suffix
+
+ if OtherId.USE_REDUCTION_MODE_AS_SUFFIX in self._input_dict:
+ use_reduction_mode_as_suffix = self._input_dict[OtherId.USE_REDUCTION_MODE_AS_SUFFIX]
+ use_reduction_mode_as_suffix = use_reduction_mode_as_suffix[-1]
+ state.use_reduction_mode_as_suffix = use_reduction_mode_as_suffix
+ return state
+
+ def get_state_scale(self): # -> StateScale:
+ state = StateScale()
+
+ # We only extract the first entry here, ie the s entry. Although there are other entries which a user can
+ # specify such as a, b, c, d they seem to be
+ if SetId.SCALES in self._input_dict:
+ scales = self._input_dict[SetId.SCALES]
+ scales = scales[-1]
+ state.scale = scales.s
+
+ # We can also have settings for the sample geometry (Note that at the moment this is not settable via the
+ # user file nor the command line interface
+ if OtherId.SAMPLE_SHAPE in self._input_dict:
+ sample_shape = self._input_dict[OtherId.SAMPLE_SHAPE]
+ sample_shape = sample_shape[-1]
+ state.shape = sample_shape
+
+ if OtherId.SAMPLE_WIDTH in self._input_dict:
+ sample_width = self._input_dict[OtherId.SAMPLE_WIDTH]
+ sample_width = sample_width[-1]
+ state.width = sample_width
+
+ if OtherId.SAMPLE_HEIGHT in self._input_dict:
+ sample_height = self._input_dict[OtherId.SAMPLE_HEIGHT]
+ sample_height = sample_height[-1]
+ state.height = sample_height
+
+ if OtherId.SAMPLE_THICKNESS in self._input_dict:
+ sample_thickness = self._input_dict[OtherId.SAMPLE_THICKNESS]
+ sample_thickness = sample_thickness[-1]
+ state.thickness = sample_thickness
+ return state
+
+ def get_state_slice_event(self): # -> StateSliceEvent:
+ state = StateSliceEvent()
+
+ # Setting up the slice limits is current
+ if OtherId.EVENT_SLICES in self._input_dict:
+ event_slices = self._input_dict[OtherId.EVENT_SLICES]
+ event_slices = event_slices[-1]
+ # The events binning can come in three forms.
+ # 1. As a simple range object
+ # 2. As an already parsed rebin array, ie min, step, max
+ # 3. As a string. Note that this includes custom commands.
+ if isinstance(event_slices, simple_range):
+ start, stop = get_ranges_for_rebin_setting(event_slices.start, event_slices.stop,
+ event_slices.step, event_slices.step_type)
+ elif isinstance(event_slices, rebin_string_values):
+ start, stop = get_ranges_for_rebin_array(event_slices.value)
+ else:
+ start, stop = get_ranges_from_event_slice_setting(event_slices.value)
+
+ state.start_time = start
+ state.end_time = stop
+
+ return state
+
+ def get_state_wavelength(self): # -> StateWavelength():
+ state = StateWavelength()
+ _set_wavelength_limits(state, self._input_dict)
+ return state
+
+ def get_state_wavelength_and_pixel_adjustment(self): # -> StateWavelengthAndPixelAdjustment:
+ state = StateWavelengthAndPixelAdjustment()
+ # Get the flat/flood files. There can be entries for LAB and HAB.
+ if MonId.FLAT in self._input_dict:
+ mon_flat = self._input_dict[MonId.FLAT]
+ hab_flat_entries = [item for item in mon_flat if item.detector_type is DetectorType.HAB]
+ lab_flat_entries = [item for item in mon_flat if item.detector_type is DetectorType.LAB]
+
+ if hab_flat_entries:
+ hab_flat_entry = hab_flat_entries[-1]
+ state.adjustment_files[DetectorType.HAB.value].pixel_adjustment_file = hab_flat_entry.file_path
+
+ if lab_flat_entries:
+ lab_flat_entry = lab_flat_entries[-1]
+ state.adjustment_files[DetectorType.LAB.value].pixel_adjustment_file = lab_flat_entry.file_path
+
+ # Get the direct files. There can be entries for LAB and HAB.
+ if MonId.DIRECT in self._input_dict:
+ mon_direct = self._input_dict[MonId.DIRECT]
+ hab_direct_entries = [item for item in mon_direct if item.detector_type is DetectorType.HAB]
+ lab_direct_entries = [item for item in mon_direct if item.detector_type is DetectorType.LAB]
+ if hab_direct_entries:
+ hab_direct_entry = hab_direct_entries[-1]
+ state.adjustment_files[DetectorType.HAB.value].wavelength_adjustment_file = hab_direct_entry.file_path
+
+ if lab_direct_entries:
+ lab_direct_entry = lab_direct_entries[-1]
+ state.adjustment_files[DetectorType.LAB.value].wavelength_adjustment_file = lab_direct_entry.file_path
+
+ _set_wavelength_limits(state, self._input_dict)
+ state.idf_path = self._data_info.idf_file_path
+ return state
+
+ def _set_single_entry(self, state_obj, attr_name, tag, apply_to_value=None):
+ """
+ Sets a single element on the specified builder via a specified method name.
+ If several entries were specified by the user, then the last entry is specified and the
+ :param state_obj: a state object
+ :param attr_name: the attribute to set on the state
+ :param tag: the tag of an entry which is potentially part of all_entries
+ :param apply_to_value: a function which should be applied before setting the value. If it is None, then nothing
+ happens
+ """
+ if tag in self._input_dict:
+ list_of_entries = self._input_dict[tag]
+ # We expect only one entry, but the user could have specified it several times.
+ # We select the entry which was added last.
+ entry = list_of_entries[-1]
+ if apply_to_value is not None:
+ entry = apply_to_value(entry)
+ # Set the value on the specified method
+ setattr(state_obj, attr_name, entry)
+
+
+def _convert_mm_to_m(value):
+ return value / 1000. if value else 0.0
+
+
+def _get_last_element(val):
+ return val[-1] if val else None
+
+
+def _set_wavelength_limits(state_obj, user_file_items):
+ wavelength_limits = _get_last_element(user_file_items.get(LimitsId.WAVELENGTH))
+
+ if not wavelength_limits:
+ return state_obj
+
+ if wavelength_limits.step_type in [RangeStepType.RANGE_LIN, RangeStepType.RANGE_LOG]:
+ wavelength_range = _get_last_element(user_file_items.get(OtherId.WAVELENGTH_RANGE))
+
+ wavelength_start, wavelength_stop = get_ranges_from_event_slice_setting(wavelength_range)
+ wavelength_start = [min(wavelength_start)] + wavelength_start
+ wavelength_stop = [max(wavelength_stop)] + wavelength_stop
+
+ wavelength_step_type = RangeStepType.LIN if wavelength_limits.step_type is RangeStepType.RANGE_LIN \
+ else RangeStepType.LOG
+
+ state_obj.wavelength_low = wavelength_start
+ state_obj.wavelength_high = wavelength_stop
+ state_obj.wavelength_step = wavelength_limits.step
+ state_obj.wavelength_step_type = wavelength_step_type
+ else:
+ state_obj.wavelength_low = [wavelength_limits.start]
+ state_obj.wavelength_high = [wavelength_limits.stop]
+ state_obj.wavelength_step = wavelength_limits.step
+ state_obj.wavelength_step_type = wavelength_limits.step_type
+
+ return state_obj
+
+
+def _set_prompt_peak_correction(state_obj, user_file_items):
+ fit_monitor_times = _get_last_element(user_file_items.get(FitId.MONITOR_TIMES))
+ if fit_monitor_times:
+ state_obj.prompt_peak_correction_min = fit_monitor_times.start
+ state_obj.prompt_peak_correction_max = fit_monitor_times.stop
+
+
+def _set_background_tof_general(state_obj, user_file_items):
+ # The general background settings
+ back_all_monitors = _get_last_element(user_file_items.get(BackId.ALL_MONITORS))
+ if back_all_monitors:
+ state_obj.background_TOF_general_start = back_all_monitors.start
+ state_obj.background_TOF_general_stop = back_all_monitors.stop
+
+
+def _set_background_tof_monitor(state_obj, user_file_items):
+ # The monitor off switches. Get all monitors which should not have an individual background setting
+ monitor_exclusion_list = []
+
+ back_monitor_off = user_file_items.get(BackId.MONITOR_OFF)
+ if back_monitor_off:
+ monitor_exclusion_list = list(back_monitor_off.values())
+
+ # Get all individual monitor background settings. But ignore those settings where there was an explicit
+ # off setting. Those monitors were collected in the monitor_exclusion_list collection
+ back_single_monitors = user_file_items.get(BackId.SINGLE_MONITORS)
+ if back_single_monitors:
+ background_tof_monitor_start = {}
+ background_tof_monitor_stop = {}
+
+ for element in back_single_monitors:
+ monitor = element.monitor
+ if monitor not in monitor_exclusion_list:
+ background_tof_monitor_start.update({str(monitor): element.start})
+ background_tof_monitor_stop.update({str(monitor): element.stop})
+
+ state_obj.background_TOF_monitor_start = background_tof_monitor_start
+ state_obj.background_TOF_monitor_stop = background_tof_monitor_stop
diff --git a/scripts/SANS/sans/user_file/txt_parsers/UserFileReaderAdapter.py b/scripts/SANS/sans/user_file/txt_parsers/UserFileReaderAdapter.py
new file mode 100644
index 0000000000000000000000000000000000000000..d85093d25d94245ea926a14d57d266b3f65367d1
--- /dev/null
+++ b/scripts/SANS/sans/user_file/txt_parsers/UserFileReaderAdapter.py
@@ -0,0 +1,21 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+from sans.user_file.txt_parsers.ParsedDictConverter import ParsedDictConverter
+from sans.user_file.user_file_reader import UserFileReader
+
+
+class UserFileReaderAdapter(ParsedDictConverter):
+ def __init__(self, user_file_name, data_info, txt_user_file_reader = None):
+ super(UserFileReaderAdapter, self).__init__(data_info=data_info)
+
+ if not txt_user_file_reader:
+ txt_user_file_reader = UserFileReader(user_file_name)
+
+ self._adapted_parser = txt_user_file_reader
+
+ def _get_input_dict(self): # -> dict:
+ return self._adapted_parser.read_user_file()
diff --git a/scripts/SANS/sans/user_file/txt_parsers/__init__.py b/scripts/SANS/sans/user_file/txt_parsers/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..a352cdce8dd10ff50a564de2b6e4c95bfea3c6d3
--- /dev/null
+++ b/scripts/SANS/sans/user_file/txt_parsers/__init__.py
@@ -0,0 +1,6 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
diff --git a/scripts/test/Abins/AbinsSDataTest.py b/scripts/test/Abins/AbinsSDataTest.py
new file mode 100644
index 0000000000000000000000000000000000000000..f486945e9a90c74d5dc27a01ef4ddc2fa3948a34
--- /dev/null
+++ b/scripts/test/Abins/AbinsSDataTest.py
@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+from __future__ import (absolute_import, division, print_function)
+import six
+import unittest
+import numpy as np
+import logging
+from AbinsModules import SData, AbinsParameters
+
+
+class AbinsSDataTest(unittest.TestCase):
+ def setUp(self):
+ self.default_threshold_value = AbinsParameters.sampling['s_absolute_threshold']
+ self.default_min_wavenumber = AbinsParameters.sampling['min_wavenumber']
+ self.default_max_wavenumber = AbinsParameters.sampling['max_wavenumber']
+ self.logger = logging.getLogger('abins-sdata-test')
+
+ def tearDown(self):
+ AbinsParameters.sampling['s_absolute_threshold'] = self.default_threshold_value
+ AbinsParameters.sampling['min_wavenumber'] = self.default_min_wavenumber
+ AbinsParameters.sampling['max_wavenumber'] = self.default_max_wavenumber
+
+ def test_s_data(self):
+ AbinsParameters.sampling['min_wavenumber'] = 100
+ AbinsParameters.sampling['max_wavenumber'] = 150
+
+ s_data = SData(temperature=10, sample_form='Powder')
+ s_data.set_bin_width(10)
+ s_data.set({'frequencies': np.linspace(105, 145, 5),
+ 'atom_1': {'s': {'order_1': np.array([0., 0.001, 1., 1., 0., 0.,])}}})
+
+ if six.PY3: # assertLogs is available from Python 3.4 and up
+ with self.assertRaises(AssertionError):
+ with self.assertLogs(logger=self.logger, level='WARNING'):
+ s_data.check_thresholds(logger=self.logger)
+
+ AbinsParameters.sampling['s_absolute_threshold'] = 0.5
+ with self.assertLogs(logger=self.logger, level='WARNING'):
+ s_data.check_thresholds(logger=self.logger)
diff --git a/scripts/test/Abins/CMakeLists.txt b/scripts/test/Abins/CMakeLists.txt
index 0b0e82fe5ea12b5ec0ea1507fd5f37629a6dd264..310d40042728a650b746f60ddbda266b391277fb 100644
--- a/scripts/test/Abins/CMakeLists.txt
+++ b/scripts/test/Abins/CMakeLists.txt
@@ -17,6 +17,7 @@ set ( TEST_PY_FILES
AbinsLoadDMOL3Test.py
AbinsLoadGAUSSIANTest.py
AbinsPowderDataTest.py
+ AbinsSDataTest.py
)
pyunittest_add_test(${CMAKE_CURRENT_SOURCE_DIR} python.scripts
diff --git a/scripts/test/CrystalFieldMultiSiteTest.py b/scripts/test/CrystalFieldMultiSiteTest.py
index 64d4d6d32f161ad4a8b0c1740fe073546a6173ae..14c175cdb0b54b759ee3cd4cc0ce5ba88c260477 100644
--- a/scripts/test/CrystalFieldMultiSiteTest.py
+++ b/scripts/test/CrystalFieldMultiSiteTest.py
@@ -5,6 +5,7 @@
# & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
import numpy as np
+import re
import unittest
import testhelpers
@@ -366,16 +367,18 @@ class CrystalFieldMultiSiteTests(unittest.TestCase):
cf.background.background.constraints('A1 > 0')
s = cf.makeSpectrumFunction()
- self.assertTrue('0<IntensityScaling' in s)
- self.assertTrue('B22<4' in s)
- self.assertTrue('0<bg.f0.Sigma' in s)
- self.assertTrue('0<bg.f1.A1' in s)
- self.assertTrue('Height=10.1' in s)
- self.assertTrue('A0=0.1' in s)
- self.assertTrue('pk0.FWHM<2.2' in s)
- self.assertTrue('0.1<pk1.FWHM' in s)
- self.assertTrue('pk2.FWHM=2*pk1.FWHM' in s)
- self.assertTrue('pk3.FWHM=2*pk2.FWHM' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', s))
+ constraints = ','.join(re.findall('constraints=\((.*?)\)', s))
+ self.assertTrue('0<IntensityScaling' in constraints)
+ self.assertTrue('B22<4' in constraints)
+ self.assertTrue('0<bg.f0.Sigma' in constraints)
+ self.assertTrue('0<bg.f1.A1' in constraints)
+ self.assertTrue('Height=10.1' in ties)
+ self.assertTrue('A0=0.1' in ties)
+ self.assertTrue('pk0.FWHM<2.2' in constraints)
+ self.assertTrue('0.1<pk1.FWHM' in constraints)
+ self.assertTrue('pk2.FWHM=2*pk1.FWHM' in ties)
+ self.assertTrue('pk3.FWHM=2*pk2.FWHM' in ties)
# Test that ties and constraints are correctly defined
fun = FunctionFactory.createInitialized(s)
@@ -400,17 +403,19 @@ class CrystalFieldMultiSiteTests(unittest.TestCase):
cf.constraints('sp1.pk1.FWHM > 1.1', '1 < sp1.pk4.FWHM < 2.2')
s = str(cf.function)
- self.assertTrue('0<sp0.IntensityScaling' in s)
- self.assertTrue('sp1.IntensityScaling<2' in s)
- self.assertTrue('sp0.bg.f0.Height=10.1' in s)
- self.assertTrue('sp1.bg.f0.Height=20.2' in s)
- self.assertTrue('0.1<sp0.bg.f0.Sigma' in s)
- self.assertTrue('0.2<sp1.bg.f0.Sigma' in s)
- self.assertTrue('sp0.pk1.FWHM<2.2' in s)
- self.assertTrue('1.1<sp1.pk1.FWHM' in s)
- self.assertTrue('1<sp1.pk4.FWHM<2.2' in s)
- self.assertTrue('sp1.pk2.FWHM=2*sp1.pk1.FWHM' in s)
- self.assertTrue('sp1.pk3.FWHM=2*sp1.pk2.FWHM' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', s))
+ constraints = ','.join(re.findall('constraints=\((.*?)\)', s))
+ self.assertTrue('0<sp0.IntensityScaling' in constraints)
+ self.assertTrue('sp1.IntensityScaling<2' in constraints)
+ self.assertTrue('sp0.bg.f0.Height=10.1' in ties)
+ self.assertTrue('sp1.bg.f0.Height=20.2' in ties)
+ self.assertTrue('0.1<sp0.bg.f0.Sigma' in constraints)
+ self.assertTrue('0.2<sp1.bg.f0.Sigma' in constraints)
+ self.assertTrue('sp0.pk1.FWHM<2.2' in constraints)
+ self.assertTrue('1.1<sp1.pk1.FWHM' in constraints)
+ self.assertTrue('1<sp1.pk4.FWHM<2.2' in constraints)
+ self.assertTrue('sp1.pk2.FWHM=2*sp1.pk1.FWHM' in ties)
+ self.assertTrue('sp1.pk3.FWHM=2*sp1.pk2.FWHM' in ties)
def test_constraints_multi_spectrum_and_ion(self):
from mantid.simpleapi import FlatBackground, Gaussian
@@ -432,17 +437,19 @@ class CrystalFieldMultiSiteTests(unittest.TestCase):
cf.constraints('ion0.sp1.pk1.FWHM > 1.1', '1 < ion0.sp1.pk4.FWHM < 2.2')
s = str(cf.function)
- self.assertTrue('0<sp0.IntensityScaling' in s)
- self.assertTrue('sp1.IntensityScaling<2' in s)
- self.assertTrue('sp0.bg.f0.Height=10.1' in s)
- self.assertTrue('sp1.bg.f0.Height=20.2' in s)
- self.assertTrue('0.1<sp0.bg.f0.Sigma' in s)
- self.assertTrue('0.2<sp1.bg.f0.Sigma' in s)
- self.assertTrue('ion0.sp0.pk1.FWHM<2.2' in s)
- self.assertTrue('1.1<ion0.sp1.pk1.FWHM' in s)
- self.assertTrue('1<ion0.sp1.pk4.FWHM<2.2' in s)
- self.assertTrue('ion0.sp1.pk2.FWHM=2*ion0.sp1.pk1.FWHM' in s)
- self.assertTrue('ion1.sp1.pk3.FWHM=2*ion1.sp1.pk2.FWHM' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', s))
+ constraints = ','.join(re.findall('constraints=\((.*?)\)', s))
+ self.assertTrue('0<sp0.IntensityScaling' in constraints)
+ self.assertTrue('sp1.IntensityScaling<2' in constraints)
+ self.assertTrue('sp0.bg.f0.Height=10.1' in ties)
+ self.assertTrue('sp1.bg.f0.Height=20.2' in ties)
+ self.assertTrue('0.1<sp0.bg.f0.Sigma' in constraints)
+ self.assertTrue('0.2<sp1.bg.f0.Sigma' in constraints)
+ self.assertTrue('ion0.sp0.pk1.FWHM<2.2' in constraints)
+ self.assertTrue('1.1<ion0.sp1.pk1.FWHM' in constraints)
+ self.assertTrue('1<ion0.sp1.pk4.FWHM<2.2' in constraints)
+ self.assertTrue('ion0.sp1.pk2.FWHM=2*ion0.sp1.pk1.FWHM' in ties)
+ self.assertTrue('ion1.sp1.pk3.FWHM=2*ion1.sp1.pk2.FWHM' in ties)
def test_add_CrystalField(self):
from CrystalField import CrystalField
@@ -463,9 +470,9 @@ class CrystalFieldMultiSiteTests(unittest.TestCase):
self.assertTrue('Pr' in cf2.Ions)
self.assertEqual(len(cf2.Symmetries), 2)
s = str(cf2.function)
- self.assertTrue('ion1.IntensityScaling=1.0*ion0.IntensityScaling' in s or
- 'ion0.IntensityScaling=1.0*ion1.IntensityScaling' in s) # either possible in python 3
-
+ ties = ','.join(re.findall('ties=\((.*?)\)', s))
+ self.assertTrue('ion1.IntensityScaling=1.0*ion0.IntensityScaling' in ties or
+ 'ion0.IntensityScaling=1.0*ion1.IntensityScaling' in ties) # either possible in python 3
def test_add_CrystalFieldSite(self):
from CrystalField import CrystalField
@@ -486,7 +493,8 @@ class CrystalFieldMultiSiteTests(unittest.TestCase):
self.assertTrue('Pr' in cf2.Ions)
self.assertEqual(len(cf2.Symmetries), 2)
s = str(cf2.function)
- self.assertTrue('ion0.IntensityScaling=0.125*ion1.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', s))
+ self.assertTrue('ion0.IntensityScaling=0.125*ion1.IntensityScaling' in ties)
def test_add_CrystalFieldMultiSite(self):
cfms1 = CrystalFieldMultiSite(Ions=['Pm'], Symmetries=['D2'], Temperatures=[44, 50], FWHM=[1.1, 0.9],
@@ -502,10 +510,11 @@ class CrystalFieldMultiSiteTests(unittest.TestCase):
self.assertEqual(cfms3['ion1.B22'], 3.9770)
self.assertEqual(cfms3['ion2.B40'], -0.03)
s = str(cfms3.function)
- self.assertTrue('ion1.IntensityScaling=1.0*ion0.IntensityScaling' in s or
- 'ion0.IntensityScaling=1.0*ion1.IntensityScaling' in s)
- self.assertTrue('ion0.IntensityScaling=1.0*ion2.IntensityScaling' in s or
- 'ion2.IntensityScaling=1.0*ion0.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', s))
+ self.assertTrue('ion1.IntensityScaling=1.0*ion0.IntensityScaling' in ties or
+ 'ion0.IntensityScaling=1.0*ion1.IntensityScaling' in ties)
+ self.assertTrue('ion0.IntensityScaling=1.0*ion2.IntensityScaling' in ties or
+ 'ion2.IntensityScaling=1.0*ion0.IntensityScaling' in ties)
def test_multi_ion_intensity_scaling(self):
from CrystalField import CrystalField
@@ -514,45 +523,45 @@ class CrystalFieldMultiSiteTests(unittest.TestCase):
cf1 = CrystalField('Ce', 'C2v', **params)
cf2 = CrystalField('Pr', 'C2v', **params)
cf = cf1 + cf2
- s = str(cf.function)
- self.assertTrue('ion1.IntensityScaling=1.0*ion0.IntensityScaling' in s or
- 'ion0.IntensityScaling=1.0*ion1.IntensityScaling' in s) # either possible in python 3
-
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion1.IntensityScaling=1.0*ion0.IntensityScaling' in ties or
+ 'ion0.IntensityScaling=1.0*ion1.IntensityScaling' in ties) # either possible in python 3
cf = 2 * cf1 + cf2 * 8
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.25*ion1.IntensityScaling' in s)
+
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.25*ion1.IntensityScaling' in ties)
cf = 2 * cf1 + cf2
- s = str(cf.function)
- self.assertTrue('ion1.IntensityScaling=0.5*ion0.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion1.IntensityScaling=0.5*ion0.IntensityScaling' in ties)
cf3 = CrystalField('Tb', 'C2v', **params)
cf = 2 * cf1 + cf2 * 8 + cf3
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.25*ion1.IntensityScaling' in s)
- self.assertTrue('ion2.IntensityScaling=0.125*ion1.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.25*ion1.IntensityScaling' in ties)
+ self.assertTrue('ion2.IntensityScaling=0.125*ion1.IntensityScaling' in ties)
cf = 2 * cf1 + cf2 * 8 + 10 * cf3
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in s)
- self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in ties)
cf = 2 * cf1 + (cf2 * 8 + 10 * cf3)
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in s)
- self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in ties)
cf = cf1 + (cf2 * 8 + 10 * cf3)
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.1*ion2.IntensityScaling' in s)
- self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.1*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in ties)
cf4 = CrystalField('Yb', 'C2v', **params)
cf = (2 * cf1 + cf2 * 8) + (10 * cf3 + cf4)
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in s)
- self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in s)
- self.assertTrue('ion3.IntensityScaling=0.1*ion2.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion3.IntensityScaling=0.1*ion2.IntensityScaling' in ties)
def test_multi_ion_intensity_scaling_multi_spectrum(self):
from CrystalField import CrystalField
@@ -561,42 +570,42 @@ class CrystalFieldMultiSiteTests(unittest.TestCase):
cf1 = CrystalField('Ce', 'C2v', **params)
cf2 = CrystalField('Pr', 'C2v', **params)
cf = cf1 + cf2
- s = str(cf.function)
- self.assertTrue('ion1.IntensityScaling=1.0*ion0.IntensityScaling' in s or
- 'ion0.IntensityScaling=1.0*ion1.IntensityScaling' in s) # either possible in python 3
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion1.IntensityScaling=1.0*ion0.IntensityScaling' in ties or
+ 'ion0.IntensityScaling=1.0*ion1.IntensityScaling' in ties) # either possible in python 3
cf = 2 * cf1 + cf2 * 8
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.25*ion1.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.25*ion1.IntensityScaling' in ties)
cf = 2 * cf1 + cf2
- s = str(cf.function)
- self.assertTrue('ion1.IntensityScaling=0.5*ion0.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion1.IntensityScaling=0.5*ion0.IntensityScaling' in ties)
cf3 = CrystalField('Tb', 'C2v', **params)
cf = 2 * cf1 + cf2 * 8 + cf3
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.25*ion1.IntensityScaling' in s)
- self.assertTrue('ion2.IntensityScaling=0.125*ion1.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.25*ion1.IntensityScaling' in ties)
+ self.assertTrue('ion2.IntensityScaling=0.125*ion1.IntensityScaling' in ties)
cf = 2 * cf1 + cf2 * 8 + 10 * cf3
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in s)
- self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in ties)
cf = 2 * cf1 + (cf2 * 8 + 10 * cf3)
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in s)
- self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in ties)
cf = cf1 + (cf2 * 8 + 10 * cf3)
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.1*ion2.IntensityScaling' in s)
- self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.1*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in ties)
cf4 = CrystalField('Yb', 'C2v', **params)
cf = (2 * cf1 + cf2 * 8) + (10 * cf3 + cf4)
- s = str(cf.function)
- self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in s)
- self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in s)
- self.assertTrue('ion3.IntensityScaling=0.1*ion2.IntensityScaling' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', str(cf.function)))
+ self.assertTrue('ion0.IntensityScaling=0.2*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion1.IntensityScaling=0.8*ion2.IntensityScaling' in ties)
+ self.assertTrue('ion3.IntensityScaling=0.1*ion2.IntensityScaling' in ties)
diff --git a/scripts/test/CrystalFieldTest.py b/scripts/test/CrystalFieldTest.py
index 730d03e723bce1764ff5efb49a1d3e6308dac81b..69a1c8f7e04fa246c00b0ca2b49fc0e9ac82fa85 100644
--- a/scripts/test/CrystalFieldTest.py
+++ b/scripts/test/CrystalFieldTest.py
@@ -9,6 +9,7 @@
from __future__ import (absolute_import, division, print_function)
import unittest
import numpy as np
+import re
from scipy.constants import physical_constants
# Import mantid to setup the python paths to the bundled scripts
@@ -341,29 +342,29 @@ class CrystalFieldTests(unittest.TestCase):
self.assertAlmostEqual(y[90], 0.95580997734199358, 8)
def test_api_CrystalField_spectrum_background_no_background(self):
- from CrystalField import CrystalField, PeaksFunction, Background, Function
- cf = CrystalField('Ce', 'C2v', B20=0.035, B40=-0.012, B43=-0.027, B60=-0.00012, B63=0.0025, B66=0.0068,
- Temperature=10.0, FWHM=0.1)
- cf.PeakShape = 'Gaussian'
- cf.peaks.param[1]['Sigma'] = 0.1
- cf.peaks.param[2]['Sigma'] = 0.2
- cf.peaks.param[3]['Sigma'] = 0.3
- cf.background = Background(peak=Function('PseudoVoigt', Intensity=10*c_mbsr, FWHM=1, Mixing=0.5))
- self.assertEqual(cf.background.peak.param['Mixing'], 0.5)
- self.assertEqual(cf.peaks.param[1]['Sigma'], 0.1)
- self.assertEqual(cf.peaks.param[2]['Sigma'], 0.2)
- self.assertEqual(cf.peaks.param[3]['Sigma'], 0.3)
- self.assertEqual(cf.function.getParameterValue('f1.f1.Sigma'), 0.1)
- self.assertEqual(cf.function.getParameterValue('f1.f2.Sigma'), 0.2)
- self.assertEqual(cf.function.getParameterValue('f1.f3.Sigma'), 0.3)
-
- x, y = cf.getSpectrum()
- y = y / c_mbsr
- # FIXME - 20181214 - Whether this change makes sense?
- # self.assertAlmostEqual(y[80], 1.6760206483896094, 8)
- # self.assertAlmostEqual(y[90], 5.7168155143063295, 8)
- self.assertAlmostEqual(y[80], 1.2216700379880412, 8)
- self.assertAlmostEqual(y[90], 4.5205109893157038, 8)
+ from CrystalField import CrystalField, PeaksFunction, Background, Function
+ cf = CrystalField('Ce', 'C2v', B20=0.035, B40=-0.012, B43=-0.027, B60=-0.00012, B63=0.0025, B66=0.0068,
+ Temperature=10.0, FWHM=0.1)
+ cf.PeakShape = 'Gaussian'
+ cf.peaks.param[1]['Sigma'] = 0.1
+ cf.peaks.param[2]['Sigma'] = 0.2
+ cf.peaks.param[3]['Sigma'] = 0.3
+ cf.background = Background(peak=Function('PseudoVoigt', Intensity=10*c_mbsr, FWHM=1, Mixing=0.5))
+ self.assertEqual(cf.background.peak.param['Mixing'], 0.5)
+ self.assertEqual(cf.peaks.param[1]['Sigma'], 0.1)
+ self.assertEqual(cf.peaks.param[2]['Sigma'], 0.2)
+ self.assertEqual(cf.peaks.param[3]['Sigma'], 0.3)
+ self.assertEqual(cf.function.getParameterValue('f1.f1.Sigma'), 0.1)
+ self.assertEqual(cf.function.getParameterValue('f1.f2.Sigma'), 0.2)
+ self.assertEqual(cf.function.getParameterValue('f1.f3.Sigma'), 0.3)
+
+ x, y = cf.getSpectrum()
+ y = y / c_mbsr
+ # FIXME - 20181214 - Whether this change makes sense?
+ # self.assertAlmostEqual(y[80], 1.6760206483896094, 8)
+ # self.assertAlmostEqual(y[90], 5.7168155143063295, 8)
+ self.assertAlmostEqual(y[80], 1.2216700379880412, 8)
+ self.assertAlmostEqual(y[90], 4.5205109893157038, 8)
def test_api_CrystalField_multi_spectrum_background(self):
from CrystalField import CrystalField, PeaksFunction, Background, Function
@@ -575,16 +576,16 @@ class CrystalFieldFitTest(unittest.TestCase):
from CrystalField.fitting import makeWorkspace
from CrystalField import CrystalField, CrystalFieldFit, Background, Function
origin = CrystalField('Ce', 'C2v', B20=0.37737, B22=3.9770, B40=-0.031787, B42=-0.11611, B44=-0.12544,
- Temperature=44.0, FWHM=1.1)
+ Temperature=44.0, FWHM=1.1)
origin.background = Background(peak=Function('Gaussian', Height=10*c_mbsr, Sigma=1),
- background=Function('LinearBackground', A0=1.0, A1=0.01))
+ background=Function('LinearBackground', A0=1.0, A1=0.01))
x, y = origin.getSpectrum()
ws = makeWorkspace(x, y)
cf = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
- Temperature=44.0, FWHM=1.0)
+ Temperature=44.0, FWHM=1.0)
cf.background = Background(peak=Function('Gaussian', Height=10*c_mbsr, Sigma=1),
- background=Function('LinearBackground', A0=1.0, A1=0.01))
+ background=Function('LinearBackground', A0=1.0, A1=0.01))
cf.ties(B20=0.37737, IntensityScaling=1)
fit = CrystalFieldFit(cf, InputWorkspace=ws)
fit.fit()
@@ -851,16 +852,18 @@ class CrystalFieldFitTest(unittest.TestCase):
cf.background.background.constraints('A1 > 0')
s = cf.makeSpectrumFunction()
- self.assertTrue('0<IntensityScaling' in s)
- self.assertTrue('B22<4' in s)
- self.assertTrue('0<f0.f0.Sigma' in s)
- self.assertTrue('0<f0.f1.A1' in s)
- self.assertTrue('Height=10.1' in s)
- self.assertTrue('A0=0.1' in s)
- self.assertTrue('f0.FWHM<2.2' in s)
- self.assertTrue('0.1<f1.FWHM' in s)
- self.assertTrue('f2.FWHM=2*f1.FWHM' in s)
- self.assertTrue('f3.FWHM=2*f2.FWHM' in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', s))
+ constraints = ','.join(re.findall('constraints=\((.*?)\)', s))
+ self.assertTrue('0<IntensityScaling' in constraints)
+ self.assertTrue('B22<4' in constraints)
+ self.assertTrue('0<f0.f0.Sigma' in constraints)
+ self.assertTrue('0<f0.f1.A1' in constraints)
+ self.assertTrue('Height=10.1' in ties)
+ self.assertTrue('A0=0.1' in ties)
+ self.assertTrue('f0.FWHM<2.2' in constraints)
+ self.assertTrue('0.1<f1.FWHM' in constraints)
+ self.assertTrue('f2.FWHM=2*f1.FWHM' in ties)
+ self.assertTrue('f3.FWHM=2*f2.FWHM' in ties)
# Test that ties and constraints are correctly defined
fun = FunctionFactory.createInitialized(s)
@@ -872,18 +875,38 @@ class CrystalFieldFitTest(unittest.TestCase):
cf = CrystalField('Ce', 'C2v', B20=0.37737, B22=3.9770, B40=-0.031787, B42=-0.11611, B44=-0.12544,
Temperature=50, FWHM=0.9)
- cf.peaks.tieAll(' FWHM=2.1', 3)
+ cf.peaks.tieAll('FWHM=2.1', 3)
s = cf.makeSpectrumFunction()
- self.assertTrue('f0.FWHM=2.1' in s)
- self.assertTrue('f1.FWHM=2.1' in s)
- self.assertTrue('f2.FWHM=2.1' in s)
- self.assertTrue('f3.FWHM=2.1' not in s)
+ ties = ','.join(re.findall('ties=\((.*?)\)', s))
+ self.assertTrue('f0.FWHM=2.1' in ties)
+ self.assertTrue('f1.FWHM=2.1' in ties)
+ self.assertTrue('f2.FWHM=2.1' in ties)
+ self.assertTrue('f3.FWHM=2.1' not in ties)
# Test that ties and constraints are correctly defined
fun = FunctionFactory.createInitialized(s)
self.assertNotEqual(fun, None)
+ def test_ties_do_not_change_during_fit(self):
+ from CrystalField import CrystalField, CrystalFieldFit
+ from CrystalField.fitting import makeWorkspace
+
+ cf = CrystalField('Ce', 'C2v', B20=0.37737, B22=3.9770, B40=-0.031787, B42=-0.11611, B44=-0.12544,
+ Temperature=50, FWHM=0.9)
+ x, y = cf.getSpectrum()
+ ws = makeWorkspace(x, y)
+
+ cf.peaks.tieAll('FWHM=2.1', 3)
+
+ fit = CrystalFieldFit(Model=cf, InputWorkspace=ws)
+ fit.fit()
+
+ self.assertEqual(cf.peaks.param[0]['FWHM'], 2.1)
+ self.assertEqual(cf.peaks.param[1]['FWHM'], 2.1)
+ self.assertEqual(cf.peaks.param[2]['FWHM'], 2.1)
+ self.assertNotEqual(cf.peaks.param[3]['FWHM'], 2.1)
+
def test_all_peak_ties_single_spectrum_range(self):
from CrystalField import CrystalField, CrystalFieldFit, Background, Function
from mantid.simpleapi import FunctionFactory
@@ -893,12 +916,13 @@ class CrystalFieldFitTest(unittest.TestCase):
cf.peaks.tieAll('FWHM=f0.FWHM', 1, 4)
s = cf.makeSpectrumFunction()
- self.assertTrue('f0.FWHM=f0.FWHM' not in s)
- self.assertTrue('f1.FWHM=f0.FWHM' in s)
- self.assertTrue('f2.FWHM=f0.FWHM' in s)
- self.assertTrue('f3.FWHM=f0.FWHM' in s)
- self.assertTrue('f4.FWHM=f0.FWHM' in s)
- self.assertTrue('f5.FWHM=f0.FWHM' not in s)
+ ties = ','.join(re.findall(',ties=\((.*?)\)', s))
+ self.assertTrue('f0.FWHM=f0.FWHM' not in ties)
+ self.assertTrue('f1.FWHM=f0.FWHM' in ties)
+ self.assertTrue('f2.FWHM=f0.FWHM' in ties)
+ self.assertTrue('f3.FWHM=f0.FWHM' in ties)
+ self.assertTrue('f4.FWHM=f0.FWHM' in ties)
+ self.assertTrue('f5.FWHM=f0.FWHM' not in ties)
# Test that ties and constraints are correctly defined
fun = FunctionFactory.createInitialized(s)
@@ -913,10 +937,11 @@ class CrystalFieldFitTest(unittest.TestCase):
cf.peaks.constrainAll('0.1 < FWHM <=2.1', 3)
s = cf.makeSpectrumFunction()
- self.assertTrue('0.1<f0.FWHM<2.1' in s)
- self.assertTrue('0.1<f1.FWHM<2.1' in s)
- self.assertTrue('0.1<f2.FWHM<2.1' in s)
- self.assertTrue('0.1<f3.FWHM<2.1' not in s)
+ constraints = ','.join(re.findall('constraints=\((.*?)\)', s))
+ self.assertTrue('0.1<f0.FWHM<2.1' in constraints)
+ self.assertTrue('0.1<f1.FWHM<2.1' in constraints)
+ self.assertTrue('0.1<f2.FWHM<2.1' in constraints)
+ self.assertTrue('0.1<f3.FWHM<2.1' not in constraints)
# Test that ties and constraints are correctly defined
fun = FunctionFactory.createInitialized(s)
@@ -931,10 +956,11 @@ class CrystalFieldFitTest(unittest.TestCase):
cf.peaks.constrainAll('0.1 < FWHM <=2.1', 1, 2)
s = cf.makeSpectrumFunction()
- self.assertTrue('0.1<f0.FWHM<2.1' not in s)
- self.assertTrue('0.1<f1.FWHM<2.1' in s)
- self.assertTrue('0.1<f2.FWHM<2.1' in s)
- self.assertTrue('0.1<f3.FWHM<2.1' not in s)
+ constraints = ','.join(re.findall('constraints=\((.*?)\)', s))
+ self.assertTrue('0.1<f0.FWHM<2.1' not in constraints)
+ self.assertTrue('0.1<f1.FWHM<2.1' in constraints)
+ self.assertTrue('0.1<f2.FWHM<2.1' in constraints)
+ self.assertTrue('0.1<f3.FWHM<2.1' not in constraints)
# Test that ties and constraints are correctly defined
fun = FunctionFactory.createInitialized(s)
@@ -948,7 +974,7 @@ class CrystalFieldFitTest(unittest.TestCase):
Temperature=[44.0, 50], FWHM=[1.1, 0.9])
cf.PeakShape = 'Lorentzian'
cf.background = Background(peak=Function('Gaussian', Height=10, Sigma=0.3),
- background=Function('FlatBackground', A0=1.0))
+ background=Function('FlatBackground', A0=1.0))
cf.constraints('IntensityScaling0 > 0', '0 < IntensityScaling1 < 2', 'B22 < 4')
cf.background[0].peak.ties(Height=10.1)
cf.background[0].peak.constraints('Sigma > 0.1')
@@ -960,20 +986,22 @@ class CrystalFieldFitTest(unittest.TestCase):
cf.peaks[1].constraints('f1.FWHM > 1.1', '1 < f4.FWHM < 2.2')
s = cf.makeMultiSpectrumFunction()
-
- self.assertTrue('0<IntensityScaling0' in s)
- self.assertTrue('IntensityScaling1<2' in s)
- self.assertTrue('f0.f0.f0.Height=10.1' in s)
- self.assertTrue('f1.f0.f0.Height=20.2' in s)
- self.assertTrue('0.1<f0.f0.f0.Sigma' in s)
- self.assertTrue('0.2<f1.f0.f0.Sigma' in s)
- self.assertTrue('f0.f1.FWHM<2.2' in s)
- self.assertTrue('1.1<f1.f1.FWHM' in s)
- self.assertTrue('1<f1.f4.FWHM<2.2' in s)
- self.assertTrue('f1.f2.FWHM=2*f1.f1.FWHM' in s)
- self.assertTrue('f1.f3.FWHM=2*f1.f2.FWHM' in s)
+ ties = ','.join(re.findall(',ties=\((.*?)\)', s))
+ constraints = ','.join(re.findall('constraints=\((.*?)\)', s))
+ self.assertTrue('0<IntensityScaling0' in constraints)
+ self.assertTrue('IntensityScaling1<2' in constraints)
+ self.assertTrue('f0.f0.f0.Height=10.1' in ties)
+ self.assertTrue('f1.f0.f0.Height=20.2' in ties)
+ self.assertTrue('0.1<f0.f0.f0.Sigma' in constraints)
+ self.assertTrue('0.2<f1.f0.f0.Sigma' in constraints)
+ self.assertTrue('f0.f1.FWHM<2.2' in constraints)
+ self.assertTrue('1.1<f1.f1.FWHM' in constraints)
+ self.assertTrue('1<f1.f4.FWHM<2.2' in constraints)
+ self.assertTrue('f1.f2.FWHM=2*f1.f1.FWHM' in ties)
+ self.assertTrue('f1.f3.FWHM=2*f1.f2.FWHM' in ties)
fun = FunctionFactory.createInitialized(s)
+ self.assertNotEqual(fun, None)
def test_all_peak_ties_multi_spectrum(self):
from CrystalField import CrystalField, CrystalFieldFit, Background, Function
@@ -985,18 +1013,19 @@ class CrystalFieldFitTest(unittest.TestCase):
cf.peaks[1].tieAll('FWHM=3.14', 4)
s = cf.makeMultiSpectrumFunction()
- self.assertTrue('f0.f1.FWHM=f0.f1.FWHM' not in s)
- self.assertTrue('f0.f2.FWHM=f0.f1.FWHM' in s)
- self.assertTrue('f0.f3.FWHM=f0.f1.FWHM' in s)
- self.assertTrue('f0.f4.FWHM=f0.f1.FWHM' in s)
- self.assertTrue('f0.f5.FWHM=f0.f1.FWHM' not in s)
-
- self.assertTrue('f1.f0.FWHM=3.14' not in s)
- self.assertTrue('f1.f1.FWHM=3.14' in s)
- self.assertTrue('f1.f2.FWHM=3.14' in s)
- self.assertTrue('f1.f3.FWHM=3.14' in s)
- self.assertTrue('f1.f4.FWHM=3.14' in s)
- self.assertTrue('f1.f5.FWHM=3.14' not in s)
+ ties = ','.join(re.findall(',ties=\((.*?)\)', s))
+ self.assertTrue('f0.f1.FWHM=f0.f1.FWHM' not in ties)
+ self.assertTrue('f0.f2.FWHM=f0.f1.FWHM' in ties)
+ self.assertTrue('f0.f3.FWHM=f0.f1.FWHM' in ties)
+ self.assertTrue('f0.f4.FWHM=f0.f1.FWHM' in ties)
+ self.assertTrue('f0.f5.FWHM=f0.f1.FWHM' not in ties)
+
+ self.assertTrue('f1.f0.FWHM=3.14' not in ties)
+ self.assertTrue('f1.f1.FWHM=3.14' in ties)
+ self.assertTrue('f1.f2.FWHM=3.14' in ties)
+ self.assertTrue('f1.f3.FWHM=3.14' in ties)
+ self.assertTrue('f1.f4.FWHM=3.14' in ties)
+ self.assertTrue('f1.f5.FWHM=3.14' not in ties)
# Test that ties and constraints are correctly defined
fun = FunctionFactory.createInitialized(s)
@@ -1012,16 +1041,17 @@ class CrystalFieldFitTest(unittest.TestCase):
cf.peaks[1].constrainAll('FWHM > 12.1', 3, 5)
s = cf.makeMultiSpectrumFunction()
- self.assertTrue('0.1<f0.f0.FWHM<2.1' not in s)
- self.assertTrue('0.1<f0.f1.FWHM<2.1' in s)
- self.assertTrue('0.1<f0.f2.FWHM<2.1' in s)
- self.assertTrue('0.1<f0.f4.FWHM<2.1' not in s)
-
- self.assertTrue('12.1<f1.f2.FWHM' not in s)
- self.assertTrue('12.1<f1.f3.FWHM' in s)
- self.assertTrue('12.1<f1.f4.FWHM' in s)
- self.assertTrue('12.1<f1.f5.FWHM' in s)
- self.assertTrue('12.1<f1.f6.FWHM' not in s)
+ constraints = ','.join(re.findall('constraints=\((.*?)\)', s))
+ self.assertTrue('0.1<f0.f0.FWHM<2.1' not in constraints)
+ self.assertTrue('0.1<f0.f1.FWHM<2.1' in constraints)
+ self.assertTrue('0.1<f0.f2.FWHM<2.1' in constraints)
+ self.assertTrue('0.1<f0.f4.FWHM<2.1' not in constraints)
+
+ self.assertTrue('12.1<f1.f2.FWHM' not in constraints)
+ self.assertTrue('12.1<f1.f3.FWHM' in constraints)
+ self.assertTrue('12.1<f1.f4.FWHM' in constraints)
+ self.assertTrue('12.1<f1.f5.FWHM' in constraints)
+ self.assertTrue('12.1<f1.f6.FWHM' not in constraints)
# Test that ties and constraints are correctly defined
fun = FunctionFactory.createInitialized(s)
@@ -1052,7 +1082,7 @@ class CrystalFieldFitTest(unittest.TestCase):
def test_resolution_single_spectrum(self):
from CrystalField import CrystalField
cf = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
- Temperature=44.0, FWHM=1.0, ResolutionModel=([0, 50], [1, 2]))
+ Temperature=44.0, FWHM=1.0, ResolutionModel=([0, 50], [1, 2]))
self.assertAlmostEqual(cf.peaks.param[0]['FWHM'], 1.0, 8)
self.assertAlmostEqual(cf.peaks.param[1]['FWHM'], 1.581014682, 8)
self.assertAlmostEqual(cf.peaks.param[2]['FWHM'], 1.884945866, 8)
@@ -1061,7 +1091,7 @@ class CrystalFieldFitTest(unittest.TestCase):
from CrystalField import CrystalField, CrystalFieldFit
from CrystalField.fitting import makeWorkspace
origin = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
- Temperature=44.0, FWHM=1.0)
+ Temperature=44.0, FWHM=1.0)
origin.peaks.param[0]['FWHM'] = 1.01
origin.peaks.param[1]['FWHM'] = 1.4
origin.peaks.param[2]['FWHM'] = 1.8
@@ -1083,7 +1113,7 @@ class CrystalFieldFitTest(unittest.TestCase):
from CrystalField import CrystalField, CrystalFieldFit
from CrystalField.fitting import makeWorkspace
origin = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
- Temperature=44.0, FWHM=1.0)
+ Temperature=44.0, FWHM=1.0)
origin.peaks.param[0]['FWHM'] = 1.01
origin.peaks.param[1]['FWHM'] = 1.4
origin.peaks.param[2]['FWHM'] = 1.8
@@ -1169,7 +1199,7 @@ class CrystalFieldFitTest(unittest.TestCase):
rm = ResolutionModel((x, y))
cf = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
- Temperature=44.0, FWHM=1.0, ResolutionModel=rm)
+ Temperature=44.0, FWHM=1.0, ResolutionModel=rm)
sp = cf.getSpectrum()
self.assertAlmostEqual(cf.peaks.param[1]['PeakCentre'], 29.0507341109, 8)
self.assertAlmostEqual(cf.peaks.param[0]['FWHM'], 1.0, 8)
@@ -1184,7 +1214,7 @@ class CrystalFieldFitTest(unittest.TestCase):
rm = ResolutionModel((x, y))
cf = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
- Temperature=44.0, FWHM=1.0, ResolutionModel=rm, FWHMVariation=0.3)
+ Temperature=44.0, FWHM=1.0, ResolutionModel=rm, FWHMVariation=0.3)
sp = cf.getSpectrum()
self.assertAlmostEqual(cf.peaks.param[0]['FWHM'], 1.0, 8)
self.assertAlmostEqual(cf.peaks.param[1]['FWHM'], 1.58101, 1)
@@ -1200,7 +1230,7 @@ class CrystalFieldFitTest(unittest.TestCase):
rm = ResolutionModel([(x0, y0), (x1, y1)])
cf = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
- Temperature=[44.0, 50], ResolutionModel=rm)
+ Temperature=[44.0, 50], ResolutionModel=rm)
att = cf.function.getAttributeValue('FWHMX0')
self.assertEqual(att[0], 0)
@@ -1225,7 +1255,7 @@ class CrystalFieldFitTest(unittest.TestCase):
rm = ResolutionModel([(x0, y0), (x1, y1)])
cf = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
- Temperature=[44.0, 50], ResolutionModel=rm, FWHMVariation=0.1)
+ Temperature=[44.0, 50], ResolutionModel=rm, FWHMVariation=0.1)
att = cf.function.getAttributeValue('FWHMX0')
self.assertEqual(att[0], 0)
@@ -1449,7 +1479,7 @@ class CrystalFieldFitTest(unittest.TestCase):
from mantid.geometry import CrystalStructure
from mantid.simpleapi import CreateWorkspace, DeleteWorkspace
import uuid
- perovskite = CrystalStructure('4 4 4', 'P m -3 m',
+ perovskite = CrystalStructure('4 4 4', 'P m -3 m',
'Ce 0. 0. 0. 1. 0.; Al 0.5 0.5 0.5 1. 0.; O 0.5 0.5 0. 1. 0.')
# Check direct input of CrystalStructure works
pc = PointCharge(perovskite, 'Ce', {'Ce':3, 'Al':3, 'O':-2})
@@ -1530,7 +1560,7 @@ class CrystalFieldFitTest(unittest.TestCase):
# Fits multiple INS spectra and multiple physical properties
cf = CrystalField('Ce', 'C2v', B20=0.37, B22=3.97, B40=-0.0317, B42=-0.116, B44=-0.12,
Temperature=[10, 100], FWHM=[1.1, 1.2], PhysicalProperty = [PhysicalProperties('susc', 'powder'),
- PhysicalProperties('M(H)', Hdir=[0,1,0])])
+ PhysicalProperties('M(H)', Hdir=[0,1,0])])
fit = CrystalFieldFit(Model=cf, InputWorkspace=[ws0, ws1, wschi, wsmag], MaxIterations=1)
fit.fit()
diff --git a/scripts/test/MultiPlotting/MultiPlottingContext_test.py b/scripts/test/MultiPlotting/MultiPlottingContext_test.py
index 0390bb4d191bd882b114a8b292f44fe90e7bccfd..05a4aaa688ec8ee534b0a5d49c03c726b8366d46 100644
--- a/scripts/test/MultiPlotting/MultiPlottingContext_test.py
+++ b/scripts/test/MultiPlotting/MultiPlottingContext_test.py
@@ -85,7 +85,7 @@ class MultiPlottingContextTest(unittest.TestCase):
no_lines = 1
ws = mock.MagicMock()
- with mock.patch("mantid.plots.plotfunctions.plot") as patch:
+ with mock.patch("mantid.plots.axesfunctions.plot") as patch:
patch.return_value = tuple([line()])
for name in names:
diff --git a/scripts/test/MultiPlotting/SubPlotContext_test.py b/scripts/test/MultiPlotting/SubPlotContext_test.py
index 44cd7da5a64f7c5e057151f74d4b333e7cc8b919..34748edfcfe04bd500b3ca2c6d8f29f3cb4bee4a 100644
--- a/scripts/test/MultiPlotting/SubPlotContext_test.py
+++ b/scripts/test/MultiPlotting/SubPlotContext_test.py
@@ -46,7 +46,7 @@ class SubPlotContextTest(unittest.TestCase):
def test_add_line_no_erros(self):
ws = mock.MagicMock()
- with mock.patch("mantid.plots.plotfunctions.plot") as patch:
+ with mock.patch("mantid.plots.axesfunctions.plot") as patch:
patch.return_value = tuple([line()])
self.context.addLine(ws, 3)
self.assertEqual(patch.call_count, 1)
@@ -56,9 +56,9 @@ class SubPlotContextTest(unittest.TestCase):
ws = mock.MagicMock()
self.context.change_errors(True)
lines = line()
- with mock.patch("mantid.plots.plotfunctions.plot") as plot:
+ with mock.patch("mantid.plots.axesfunctions.plot") as plot:
plot.return_value = tuple([lines])
- with mock.patch("mantid.plots.plotfunctions.errorbar") as patch:
+ with mock.patch("mantid.plots.axesfunctions.errorbar") as patch:
patch.return_value = errors()
self.context.addLine(ws, 3)
self.assertEqual(plot.call_count, 1)
@@ -73,9 +73,9 @@ class SubPlotContextTest(unittest.TestCase):
self.context.change_errors(True)
lines = line()
# add first line
- with mock.patch("mantid.plots.plotfunctions.plot") as plot:
+ with mock.patch("mantid.plots.axesfunctions.plot") as plot:
plot.return_value = tuple([lines])
- with mock.patch("mantid.plots.plotfunctions.errorbar") as patch:
+ with mock.patch("mantid.plots.axesfunctions.errorbar") as patch:
patch.return_value = errors()
self.context.addLine(ws, 3)
self.assertEqual(plot.call_count, 1)
@@ -93,7 +93,7 @@ class SubPlotContextTest(unittest.TestCase):
def test_redraw_no_errors(self):
ws = mock.MagicMock()
- with mock.patch("mantid.plots.plotfunctions.plot") as patch:
+ with mock.patch("mantid.plots.axesfunctions.plot") as patch:
lines = line()
patch.return_value = tuple([lines])
self.context.addLine(ws, 3)
@@ -142,7 +142,7 @@ class SubPlotContextTest(unittest.TestCase):
ws2.name = mock.Mock(return_value="not used")
self.context.redraw = mock.Mock()
- with mock.patch("mantid.plots.plotfunctions.plot") as patch:
+ with mock.patch("mantid.plots.axesfunctions.plot") as patch:
patch.return_value = tuple([line()])
self.context.addLine(ws, 3)
self.context.addLine(ws2, 3)
@@ -169,7 +169,7 @@ class SubPlotContextTest(unittest.TestCase):
ws2.name = mock.Mock(return_value="not used")
self.context.redraw = mock.Mock()
- with mock.patch("mantid.plots.plotfunctions.plot") as patch:
+ with mock.patch("mantid.plots.axesfunctions.plot") as patch:
patch.return_value = tuple([line()])
self.context.addLine(ws, 1)
self.context.addLine(ws2, 2)
diff --git a/scripts/test/Muon/PlottingView_test.py b/scripts/test/Muon/PlottingView_test.py
index 9571863b473b5f2164e5d1f54dfa56320a749eeb..3f514cb1e566d83425ae94ec741033c515da1d62 100644
--- a/scripts/test/Muon/PlottingView_test.py
+++ b/scripts/test/Muon/PlottingView_test.py
@@ -30,7 +30,7 @@ def get_subPlot(name):
# create real lines
fig = Figure()
sub = fig.add_subplot(1, 1, 1)
- line1 = plots.plotfunctions.plot(sub, ws1, specNum=1)
+ line1 = plots.axesfunctions.plot(sub, ws1, specNum=1)
# add them both
subplot = subPlot(name)
subplot.addLine(label1, line1, ws1, 2)
diff --git a/scripts/test/SANS/algorithm_detail/calculate_sans_transmission_test.py b/scripts/test/SANS/algorithm_detail/calculate_sans_transmission_test.py
index ca0d53e1fbeed41015f134f4b756edfc6d66dbd2..c1aba21be316830bff151093b6018e12bee09111 100644
--- a/scripts/test/SANS/algorithm_detail/calculate_sans_transmission_test.py
+++ b/scripts/test/SANS/algorithm_detail/calculate_sans_transmission_test.py
@@ -12,7 +12,7 @@ import unittest
from mantid.simpleapi import CloneWorkspace, DeleteWorkspace, Load, Rebin
from sans.algorithm_detail.calculate_sans_transmission import calculate_transmission
from sans.common.enums import (RebinType, RangeStepType, FitType)
-from sans.state.calculate_transmission import get_calculate_transmission_builder
+from sans.state.StateObjects.StateCalculateTransmission import get_calculate_transmission_builder
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/algorithm_detail/convert_to_q_test.py b/scripts/test/SANS/algorithm_detail/convert_to_q_test.py
index 9a02ac4a89f43795beac8025af0d03534cb99b4c..e897dfdaa2e3961c46d9162dac7caeddf78b8b76 100644
--- a/scripts/test/SANS/algorithm_detail/convert_to_q_test.py
+++ b/scripts/test/SANS/algorithm_detail/convert_to_q_test.py
@@ -12,8 +12,8 @@ from mantid.simpleapi import DeleteWorkspace
from sans.algorithm_detail.convert_to_q import convert_workspace
from sans.common.enums import (SANSFacility, ReductionDimensionality, RangeStepType, SANSInstrument)
from sans.common.general_functions import (create_unmanaged_algorithm)
-from sans.state.convert_to_q import get_convert_to_q_builder
-from sans.state.data import get_data_builder
+from sans.state.StateObjects.StateConvertToQ import get_convert_to_q_builder
+from sans.state.StateObjects.StateData import get_data_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/algorithm_detail/create_sans_wavelength_pixel_adjustment_test.py b/scripts/test/SANS/algorithm_detail/create_sans_wavelength_pixel_adjustment_test.py
index a7118c9f349f19be65a91b37cd9d5beb44afea58..a1ec50b2e4afd7499c7b13d2b294a218c7d99abe 100644
--- a/scripts/test/SANS/algorithm_detail/create_sans_wavelength_pixel_adjustment_test.py
+++ b/scripts/test/SANS/algorithm_detail/create_sans_wavelength_pixel_adjustment_test.py
@@ -15,7 +15,7 @@ from mantid.kernel import config
from mantid.simpleapi import CreateSampleWorkspace
from sans.algorithm_detail.CreateSANSWavelengthPixelAdjustment import CreateSANSWavelengthPixelAdjustment
from sans.common.enums import (RangeStepType, DetectorType)
-from sans.state.wavelength_and_pixel_adjustment import get_wavelength_and_pixel_adjustment_builder
+from sans.state.StateObjects.StateWavelengthAndPixelAdjustment import get_wavelength_and_pixel_adjustment_builder
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/algorithm_detail/mask_sans_workspace_test.py b/scripts/test/SANS/algorithm_detail/mask_sans_workspace_test.py
index bf4bda666cb635f095236a2efb8c3239d4f841d3..e17077a4efd3941e8aaccae4a25b982409fcf72a 100644
--- a/scripts/test/SANS/algorithm_detail/mask_sans_workspace_test.py
+++ b/scripts/test/SANS/algorithm_detail/mask_sans_workspace_test.py
@@ -14,9 +14,9 @@ from sans.algorithm_detail.mask_sans_workspace import mask_workspace
from sans.common.enums import SANSFacility
from sans.common.file_information import SANSFileInformationFactory
from sans.state.Serializer import Serializer
-from sans.state.data import get_data_builder
-from sans.state.mask import get_mask_builder
-from sans.state.move import get_move_builder
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateMaskDetectors import get_mask_builder
+from sans.state.StateObjects.StateMoveDetectors import get_move_builder
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/algorithm_detail/merge_reductions_test.py b/scripts/test/SANS/algorithm_detail/merge_reductions_test.py
index 53385fbed48c247122f149e3dfd061b1dee25310..1be805f9d9b28e585b0b2709d3836b744ee6d42e 100644
--- a/scripts/test/SANS/algorithm_detail/merge_reductions_test.py
+++ b/scripts/test/SANS/algorithm_detail/merge_reductions_test.py
@@ -14,7 +14,7 @@ from sans.common.constants import EMPTY_NAME
from sans.common.enums import (DataType, ReductionMode)
from sans.common.enums import (ReductionDimensionality, FitModeForMerge)
from sans.common.general_functions import create_unmanaged_algorithm
-from sans.state.reduction_mode import StateReductionMode
+from sans.state.StateObjects.StateReductionMode import StateReductionMode
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/algorithm_detail/move_sans_instrument_component_test.py b/scripts/test/SANS/algorithm_detail/move_sans_instrument_component_test.py
index 2995d13af920ce55c521a323c8b53be6f7e97922..09b8f9d36202e25008842391a147b1e2bcdb677e 100644
--- a/scripts/test/SANS/algorithm_detail/move_sans_instrument_component_test.py
+++ b/scripts/test/SANS/algorithm_detail/move_sans_instrument_component_test.py
@@ -16,8 +16,8 @@ from sans.algorithm_detail.move_sans_instrument_component import move_component,
from sans.algorithm_detail.move_workspaces import (create_mover, SANSMoveLOQ, SANSMoveSANS2D, SANSMoveLARMORNewStyle,
SANSMoveZOOM)
from sans.common.enums import (SANSFacility, DetectorType, SANSInstrument)
-from sans.state.data import get_data_builder
-from sans.state.move import get_move_builder
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateMoveDetectors import get_move_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/algorithm_detail/move_workspaces_test.py b/scripts/test/SANS/algorithm_detail/move_workspaces_test.py
index 553921a04cb61f3261a252fe264b8e9f099c0214..a1b6ea1ca31685e9eaff29631d40163504ee3dcb 100644
--- a/scripts/test/SANS/algorithm_detail/move_workspaces_test.py
+++ b/scripts/test/SANS/algorithm_detail/move_workspaces_test.py
@@ -11,8 +11,8 @@ import unittest
import mantid.simpleapi
from sans.algorithm_detail.move_workspaces import SANSMoveZOOM, SANSMoveSANS2D
from sans.common.enums import SANSFacility, SANSInstrument, DetectorType
-from sans.state.data import get_data_builder
-from sans.state.move import get_move_builder
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateMoveDetectors import get_move_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
@@ -128,7 +128,8 @@ class MoveSans2DMonitor(unittest.TestCase):
z_pos_mon_4_after = get_monitor_pos(ws=workspace, monitor_spectrum_no=4, move_info=move_info)
- self.assertAlmostEqual(z_pos_mon_4_before, z_pos_mon_4_after)
+ self.assertAlmostEqual(calculate_new_pos_rel_to_rear(ws=workspace, move_info=move_info, offset=mon_4_dist),
+ z_pos_mon_4_after)
class MoveZoomMonitors(unittest.TestCase):
@@ -223,7 +224,8 @@ class MoveZoomMonitors(unittest.TestCase):
z_pos_mon_5_after = get_monitor_pos(ws=workspace, monitor_spectrum_no=5, move_info=move_info)
self.assertAlmostEqual(z_pos_mon_4_before + mon_4_dist, z_pos_mon_4_after)
- self.assertAlmostEqual(z_pos_mon_5_before, z_pos_mon_5_after)
+ self.assertAlmostEqual(calculate_new_pos_rel_to_rear(ws=workspace, move_info=move_info, offset=mon_5_dist),
+ z_pos_mon_5_after)
def test_moving_only_monitor_5(self):
zoom_class = SANSMoveZOOM()
diff --git a/scripts/test/SANS/algorithm_detail/normalize_to_sans_monitor_test.py b/scripts/test/SANS/algorithm_detail/normalize_to_sans_monitor_test.py
index da6afc0231baa6b730ecadc703cbd0e52c15384f..c7254cb8706b141d19a2e5d90b626bef52f5a2fa 100644
--- a/scripts/test/SANS/algorithm_detail/normalize_to_sans_monitor_test.py
+++ b/scripts/test/SANS/algorithm_detail/normalize_to_sans_monitor_test.py
@@ -12,7 +12,7 @@ from mantid.api import AnalysisDataService
from mantid.simpleapi import CreateSampleWorkspace, Rebin
from sans.algorithm_detail.normalize_to_sans_monitor import normalize_to_monitor
from sans.common.enums import (RebinType, RangeStepType)
-from sans.state.normalize_to_monitor import get_normalize_to_monitor_builder
+from sans.state.StateObjects.StateNormalizeToMonitor import get_normalize_to_monitor_builder
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/algorithm_detail/sans_slice_event_test.py b/scripts/test/SANS/algorithm_detail/sans_slice_event_test.py
index 00d404e9131bc67218dc5756e9a6397b57e165ba..c0d3ea02db772c7e815b9a6d491bb60da6d531c0 100644
--- a/scripts/test/SANS/algorithm_detail/sans_slice_event_test.py
+++ b/scripts/test/SANS/algorithm_detail/sans_slice_event_test.py
@@ -12,7 +12,7 @@ from mantid.dataobjects import Workspace2D
from mantid.kernel import DateAndTime
from mantid.simpleapi import AddTimeSeriesLog, CreateSampleWorkspace
from sans.algorithm_detail.slice_sans_event import slice_sans_event
-from sans.state.slice_event import get_slice_event_builder
+from sans.state.StateObjects.StateSliceEvent import get_slice_event_builder
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/algorithm_detail/scale_sans_workspace_test.py b/scripts/test/SANS/algorithm_detail/scale_sans_workspace_test.py
index 3ab61611cb93fe01784ce0f4e377a838c9fcc0c6..f15a0c95a957cd024be56e3f1b8cdf8c78a337dd 100644
--- a/scripts/test/SANS/algorithm_detail/scale_sans_workspace_test.py
+++ b/scripts/test/SANS/algorithm_detail/scale_sans_workspace_test.py
@@ -12,8 +12,8 @@ import unittest
from mantid.simpleapi import CreateSampleWorkspace
from sans.algorithm_detail.scale_sans_workspace import scale_workspace, _divide_by_sample_volume, _multiply_by_abs_scale
from sans.common.enums import (SANSFacility, SampleShape, SANSInstrument)
-from sans.state.data import get_data_builder
-from sans.state.scale import get_scale_builder
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateScale import get_scale_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/command_interface/CMakeLists.txt b/scripts/test/SANS/command_interface/CMakeLists.txt
index f0062fe34931ac8972a2674bb7b59246d2b048a6..260564a9cec6bd631120408f55a4d3ed44937f34 100644
--- a/scripts/test/SANS/command_interface/CMakeLists.txt
+++ b/scripts/test/SANS/command_interface/CMakeLists.txt
@@ -2,10 +2,12 @@
set(TEST_PY_FILES
batch_csv_file_parser_test.py
- command_interface_state_director_test.py)
+ command_interface_state_director_test.py
+ isis_command_interface_test.py
+ )
check_tests_valid(${CMAKE_CURRENT_SOURCE_DIR} ${TEST_PY_FILES})
# Prefix for test name=PythonAlgorithms
-pyunittest_add_test(${CMAKE_CURRENT_SOURCE_DIR} python.SANS.common_interface
+pyunittest_add_test(${CMAKE_CURRENT_SOURCE_DIR} python.SANS.command_interface
${TEST_PY_FILES})
diff --git a/scripts/test/SANS/command_interface/batch_csv_file_parser_test.py b/scripts/test/SANS/command_interface/batch_csv_file_parser_test.py
index f4d59b8032f0a46e59060abf543778b218e1ea5d..5896ee153f9176ee571565361b2b04dea8b4f0b4 100644
--- a/scripts/test/SANS/command_interface/batch_csv_file_parser_test.py
+++ b/scripts/test/SANS/command_interface/batch_csv_file_parser_test.py
@@ -9,14 +9,16 @@ from __future__ import (absolute_import, division, print_function)
import os
import unittest
+import six
+
import mantid
-from sans.command_interface.batch_csv_file_parser import BatchCsvParser
+from mantid.py3compat import csv_open_type, mock
+from sans.command_interface.batch_csv_parser import BatchCsvParser
from sans.common.constants import ALL_PERIODS
-from sans.common.enums import BatchReductionEntry
+from sans.gui_logic.models.RowEntries import RowEntries
class BatchCsvParserTest(unittest.TestCase):
-
@staticmethod
def _save_to_csv(content):
test_file_path = os.path.join(mantid.config.getString('defaultsave.directory'), 'sans_batch_test_file.csv')
@@ -35,34 +37,37 @@ class BatchCsvParserTest(unittest.TestCase):
content = "# MANTID_BATCH_FILE add more text here\n" \
"sample_sans,74044,output_as,test,new_key_word,test\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
- self.assertRaises(RuntimeError, parser.parse_batch_file)
+ parser = BatchCsvParser()
+ with self.assertRaises(KeyError):
+ parser.parse_batch_file(batch_file_path)
BatchCsvParserTest._remove_csv(batch_file_path)
- def test_raises_if_the_batch_file_contains_an_uneven_number_of_entries(self):
+ def test_raises_if_the_batch_file_uses_key_as_val(self):
content = "# MANTID_BATCH_FILE add more text here\n" \
- "sample_sans,74044,sample_trans,74024,sample_direct_beam,74014,can_sans,74019,can_trans,74020," \
+ "sample_sans,sample_trans,74024,sample_direct_beam,74014,can_sans,74019,can_trans,74020," \
"can_direct_beam,output_as, first_eim\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
- self.assertRaises(RuntimeError, parser.parse_batch_file)
+ parser = BatchCsvParser()
+ with self.assertRaises(KeyError):
+ parser.parse_batch_file(batch_file_path)
BatchCsvParserTest._remove_csv(batch_file_path)
def test_that_raises_when_sample_scatter_is_missing(self):
content = "# MANTID_BATCH_FILE add more text here\n" \
"sample_sans,,output_as,test_file\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
- self.assertRaises(RuntimeError, parser.parse_batch_file)
+ parser = BatchCsvParser()
+ with self.assertRaises(ValueError):
+ parser.parse_batch_file(batch_file_path)
BatchCsvParserTest._remove_csv(batch_file_path)
def test_that_does_not_raise_when_output_is_missing(self):
content = "# MANTID_BATCH_FILE add more text here\n" \
"sample_sans,test,output_as,\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
+ parser = BatchCsvParser()
try:
- parser.parse_batch_file()
+ parser.parse_batch_file(batch_file_path)
except RuntimeError as e:
self.fail("Batch files are not required to contain output names as these can be autogenerated. "
"Therefore we did not expect a RuntimeError to be raised when parsing batch file without an "
@@ -73,24 +78,27 @@ class BatchCsvParserTest(unittest.TestCase):
content = "# MANTID_BATCH_FILE add more text here\n" \
"sample_sans,test,output_as,test, sample_trans,test, sample_direct_beam,\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
- self.assertRaises(RuntimeError, parser.parse_batch_file)
+ parser = BatchCsvParser()
+ with self.assertRaises(ValueError):
+ parser.parse_batch_file(batch_file_path)
BatchCsvParserTest._remove_csv(batch_file_path)
def test_that_raises_when_can_transmission_is_specified_incompletely(self):
content = "# MANTID_BATCH_FILE add more text here\n" \
"sample_sans,test,output_as,test, can_trans,, can_direct_beam, test\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
- self.assertRaises(RuntimeError, parser.parse_batch_file)
+ parser = BatchCsvParser()
+ with self.assertRaises(ValueError):
+ parser.parse_batch_file(batch_file_path)
BatchCsvParserTest._remove_csv(batch_file_path)
def test_that_raises_when_can_transmission_is_specified_but_no_can_scatter(self):
content = "# MANTID_BATCH_FILE add more text here\n" \
"sample_sans,test,output_as,test, can_trans,, can_direct_beam, test\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
- self.assertRaises(RuntimeError, parser.parse_batch_file)
+ parser = BatchCsvParser()
+ with self.assertRaises(ValueError):
+ parser.parse_batch_file(batch_file_path)
BatchCsvParserTest._remove_csv(batch_file_path)
def test_that_parses_two_lines_correctly(self):
@@ -98,34 +106,30 @@ class BatchCsvParserTest(unittest.TestCase):
"sample_sans,1,sample_trans,2,sample_direct_beam,3,output_as,test_file,user_file,user_test_file\n" \
"sample_sans,1,can_sans,2,output_as,test_file2\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
+ parser = BatchCsvParser()
# Act
- output = parser.parse_batch_file()
+ output = parser.parse_batch_file(batch_file_path)
# Assert
self.assertEqual(len(output), 2)
first_line = output[0]
- # Should have 5 user specified entries and 3 period entries
- self.assertEqual(len(first_line), 8)
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_SCATTER], "1")
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_SCATTER_PERIOD], ALL_PERIODS)
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_TRANSMISSION], "2")
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_TRANSMISSION_PERIOD], ALL_PERIODS)
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_DIRECT], "3")
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_DIRECT_PERIOD], ALL_PERIODS)
- self.assertEqual(first_line[BatchReductionEntry.OUTPUT], "test_file")
- self.assertEqual(first_line[BatchReductionEntry.USER_FILE], "user_test_file")
- second_line = output[1]
+ self.assertEqual(first_line.sample_scatter, "1")
+ self.assertEqual(first_line.sample_scatter_period, ALL_PERIODS)
+ self.assertEqual(first_line.sample_transmission, "2")
+ self.assertEqual(first_line.sample_transmission_period, ALL_PERIODS)
+ self.assertEqual(first_line.sample_direct, "3")
+ self.assertEqual(first_line.sample_direct_period, ALL_PERIODS)
+ self.assertEqual(first_line.output_name, "test_file")
+ self.assertEqual(first_line.user_file, "user_test_file")
- # Should have 3 user specified entries and 2 period entries
- self.assertEqual(len(second_line), 5)
- self.assertEqual(second_line[BatchReductionEntry.SAMPLE_SCATTER], "1")
- self.assertEqual(second_line[BatchReductionEntry.SAMPLE_SCATTER_PERIOD], ALL_PERIODS)
- self.assertEqual(second_line[BatchReductionEntry.CAN_SCATTER], "2")
- self.assertEqual(second_line[BatchReductionEntry.CAN_SCATTER_PERIOD], ALL_PERIODS)
- self.assertEqual(second_line[BatchReductionEntry.OUTPUT], "test_file2")
+ second_line = output[1]
+ self.assertEqual(second_line.sample_scatter, "1")
+ self.assertEqual(second_line.sample_scatter_period, ALL_PERIODS)
+ self.assertEqual(second_line.can_scatter, "2")
+ self.assertEqual(second_line.can_scatter_period, ALL_PERIODS)
+ self.assertEqual(second_line.output_name, "test_file2")
BatchCsvParserTest._remove_csv(batch_file_path)
@@ -133,22 +137,20 @@ class BatchCsvParserTest(unittest.TestCase):
content = "# MANTID_BATCH_FILE add more text here\n" \
"sample_sans,1p7,can_sans,2P3,output_as,test_file2\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
+ parser = BatchCsvParser()
# Act
- output = parser.parse_batch_file()
+ output = parser.parse_batch_file(batch_file_path)
# Assert
self.assertEqual(len(output), 1)
first_line = output[0]
- # Should have 5 user specified entries and 3 period entries
- self.assertEqual(len(first_line), 5)
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_SCATTER], "1")
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_SCATTER_PERIOD], 7)
- self.assertEqual(first_line[BatchReductionEntry.CAN_SCATTER], "2")
- self.assertEqual(first_line[BatchReductionEntry.CAN_SCATTER_PERIOD], 3)
- self.assertEqual(first_line[BatchReductionEntry.OUTPUT], "test_file2")
+ self.assertEqual(first_line.sample_scatter, "1")
+ self.assertEqual(first_line.sample_scatter_period, 7)
+ self.assertEqual(first_line.can_scatter, "2")
+ self.assertEqual(first_line.can_scatter_period, 3)
+ self.assertEqual(first_line.output_name, "test_file2")
BatchCsvParserTest._remove_csv(batch_file_path)
@@ -157,34 +159,31 @@ class BatchCsvParserTest(unittest.TestCase):
"sample_sans,1,sample_trans,2,sample_direct_beam,3,output_as,test_file,user_file,user_test_file\n" \
"sample_sans,1,can_sans,2,output_as,test_file2,"","", background_sans, background\n"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
+ parser = BatchCsvParser()
# Act
- output = parser.parse_batch_file()
+ output = parser.parse_batch_file(batch_file_path)
# Assert
self.assertEqual(len(output), 2)
first_line = output[0]
- # Should have 5 user specified entries and 3 period entries
- self.assertEqual(len(first_line), 8)
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_SCATTER], "1")
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_SCATTER_PERIOD], ALL_PERIODS)
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_TRANSMISSION], "2")
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_TRANSMISSION_PERIOD], ALL_PERIODS)
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_DIRECT], "3")
- self.assertEqual(first_line[BatchReductionEntry.SAMPLE_DIRECT_PERIOD], ALL_PERIODS)
- self.assertEqual(first_line[BatchReductionEntry.OUTPUT], "test_file")
- self.assertEqual(first_line[BatchReductionEntry.USER_FILE], "user_test_file")
- second_line = output[1]
+ self.assertEqual(first_line.sample_scatter, "1")
+ self.assertEqual(first_line.sample_scatter_period, ALL_PERIODS)
+ self.assertEqual(first_line.sample_transmission, "2")
+ self.assertEqual(first_line.sample_transmission_period, ALL_PERIODS)
+ self.assertEqual(first_line.sample_direct, "3")
+ self.assertEqual(first_line.sample_direct_period, ALL_PERIODS)
+ self.assertEqual(first_line.output_name, "test_file")
+ self.assertEqual(first_line.user_file, "user_test_file")
+ second_line = output[1]
# Should have 3 user specified entries and 2 period entries
- self.assertEqual(len(second_line), 5)
- self.assertEqual(second_line[BatchReductionEntry.SAMPLE_SCATTER], "1")
- self.assertEqual(second_line[BatchReductionEntry.SAMPLE_SCATTER_PERIOD], ALL_PERIODS)
- self.assertEqual(second_line[BatchReductionEntry.CAN_SCATTER], "2")
- self.assertEqual(second_line[BatchReductionEntry.CAN_SCATTER_PERIOD], ALL_PERIODS)
- self.assertEqual(second_line[BatchReductionEntry.OUTPUT], "test_file2")
+ self.assertEqual(second_line.sample_scatter, "1")
+ self.assertEqual(second_line.sample_scatter_period, ALL_PERIODS)
+ self.assertEqual(second_line.can_scatter, "2")
+ self.assertEqual(second_line.can_scatter_period, ALL_PERIODS)
+ self.assertEqual(second_line.output_name, "test_file2")
BatchCsvParserTest._remove_csv(batch_file_path)
@@ -196,29 +195,79 @@ class BatchCsvParserTest(unittest.TestCase):
a batch file key"""
batch_file_row = ["sample_sans", "1", "sample_trans", "", "sample_direct_beam", "",
"can_sans", "", "can_trans", "", "can_direct_beam", "", "output_as", "", "user_file"]
+ parser = BatchCsvParser()
+ parser._parse_csv_row(batch_file_row, 0)
- content = "# MANTID_BATCH_FILE add more text here\n" + ",".join(batch_file_row)
+ def test_bare_comment_without_hash_ignored(self):
+ content = " MANTID_BATCH_FILE,foo,bar"
batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
+ parser = BatchCsvParser()
- try:
- parser._parse_row(batch_file_row, 0)
- except RuntimeError as e:
- self.fail("An error should not have been raised. Error raised was: {}".format(str(e)))
+ output = parser.parse_batch_file(batch_file_path)
+ self.assertEqual(0, len(output))
def test_can_parse_sample_geometries(self):
batch_file_row = ["sample_sans", "1", "sample_trans", "", "sample_direct_beam", "",
"can_sans", "", "can_trans", "", "can_direct_beam", "", "output_as", "", "user_file", "",
"sample_thickness", "5", "sample_height", "5", "sample_width", "5"]
-
- content = "# MANTID_BATCH_FILE add more text here\n" + ",".join(batch_file_row)
- batch_file_path = BatchCsvParserTest._save_to_csv(content)
- parser = BatchCsvParser(batch_file_path)
-
- try:
- parser._parse_row(batch_file_row, 0)
- except RuntimeError as e:
- self.fail("An error should not have been raised. Error raised was: {}".format(str(e)))
+ parser = BatchCsvParser()
+ parser._parse_csv_row(batch_file_row, 0)
+
+ def test_empty_batch_file_name_throws(self):
+ batch_file_path = "not_there.csv"
+ parser = BatchCsvParser()
+ with self.assertRaises(RuntimeError):
+ parser.parse_batch_file(batch_file_path)
+
+ def test_opens_correct_file(self):
+ mocked_handle = mock.mock_open()
+
+ expected_file_path = "/foo/bar.csv"
+ parser = BatchCsvParser()
+
+ patchable = "__builtin__.open" if six.PY2 else "builtins.open"
+ with mock.patch(patchable, mocked_handle):
+ parser.save_batch_file(rows=[], file_path=expected_file_path)
+
+ mocked_handle.assert_called_with(expected_file_path, csv_open_type)
+
+ def test_parses_row_to_csv_correctly(self):
+ test_row = RowEntries()
+ test_row.sample_scatter = "SANS2D00022025"
+ test_row.sample_transmission = "SANS2D00022052"
+ test_row.sample_direct = "SANS2D00022022"
+ test_row.output_name = "another_file"
+ test_row.user_file = "a_user_file.txt"
+ test_row.sample_thickness = "1.0"
+ test_row.sample_height = 5.0
+ test_row.sample_width = 5.4
+
+ expected = "sample_sans,SANS2D00022025," \
+ "sample_trans,SANS2D00022052,"\
+ "sample_direct_beam,SANS2D00022022," \
+ "can_sans,," \
+ "can_trans,," \
+ "can_direct_beam,,"\
+ "output_as,another_file," \
+ "user_file,a_user_file.txt," \
+ "sample_thickness,1.0,"\
+ "sample_height,5.0," \
+ "sample_width,5.4"
+
+ mocked_handle = mock.mock_open()
+ parser = BatchCsvParser()
+
+ patchable = "__builtin__.open" if six.PY2 else "builtins.open"
+ with mock.patch(patchable, mocked_handle):
+ parser.save_batch_file(rows=[test_row], file_path='')
+
+ result = mocked_handle()
+ args, kwargs = result.write.call_args
+
+ # Strip new lines etc
+ self.assertTrue(isinstance(args[0], str))
+ written = args[0].replace('\n', '').replace('\r', '')
+ self.assertEqual(expected, written)
if __name__ == '__main__':
diff --git a/scripts/test/SANS/command_interface/isis_command_interface_test.py b/scripts/test/SANS/command_interface/isis_command_interface_test.py
new file mode 100644
index 0000000000000000000000000000000000000000..88b7cf932d7be5b0bfa5d8be5ef583fe2eb32cb2
--- /dev/null
+++ b/scripts/test/SANS/command_interface/isis_command_interface_test.py
@@ -0,0 +1,63 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+import os
+import tempfile
+import unittest
+import uuid
+
+import six
+
+from mantid.py3compat import mock
+from sans.command_interface.ISISCommandInterface import MaskFile
+
+if six.PY2:
+ FileNotFoundError = IOError
+
+
+class ISISCommandInterfaceTest(unittest.TestCase):
+ def test_mask_file_raises_for_empty_file_name(self):
+ with self.assertRaises(ValueError):
+ MaskFile(file_name="")
+
+ def test_mask_file_handles_folder_paths(self):
+ tmp_dir = tempfile.gettempdir()
+ non_existent_folder = str(uuid.uuid1())
+ path_not_there = os.path.join(tmp_dir, non_existent_folder)
+
+ self.assertFalse(os.path.exists(path_not_there))
+ with self.assertRaises(FileNotFoundError):
+ MaskFile(path_not_there)
+
+ def test_mask_file_handles_non_existent_user_files(self):
+ tmp_dir = tempfile.gettempdir()
+ non_existent_file = str(uuid.uuid1())
+ file_not_there = os.path.join(tmp_dir, non_existent_file)
+
+ self.assertFalse(os.path.exists(file_not_there))
+ with self.assertRaises(FileNotFoundError):
+ MaskFile(file_not_there)
+
+ def test_mask_file_works_for_full_path(self):
+ tmp_file = tempfile.NamedTemporaryFile(mode='r')
+ path = tmp_file.name
+ self.assertTrue(os.path.isfile(path))
+
+ self.assertIsNone(MaskFile(path))
+
+ def test_mask_file_for_existing_file(self):
+ tmp_file = tempfile.NamedTemporaryFile(mode='r')
+
+ file_name = os.path.basename(tmp_file.name)
+ with mock.patch('sans.command_interface.ISISCommandInterface.find_full_file_path') as mocked_finder:
+ mocked_finder.return_value = tmp_file.name
+ self.assertIsNone(MaskFile(file_name))
+
+
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/scripts/test/SANS/common/general_functions_test.py b/scripts/test/SANS/common/general_functions_test.py
index 2ad5183eff77930dd29cb22587c878d8539f4f89..9d85dfb16e52119ffb77f9937342cff85144cdf1 100644
--- a/scripts/test/SANS/common/general_functions_test.py
+++ b/scripts/test/SANS/common/general_functions_test.py
@@ -15,14 +15,14 @@ from sans.common.constants import (SANS2D, LOQ, LARMOR)
from sans.common.enums import (ReductionMode, ReductionDimensionality, OutputParts,
SANSInstrument, DetectorType, SANSFacility, DataType)
from sans.common.general_functions import (quaternion_to_angle_and_axis, create_managed_non_child_algorithm,
- create_unmanaged_algorithm, add_to_sample_log,
+ create_unmanaged_algorithm,
get_standard_output_workspace_name, sanitise_instrument_name,
get_reduced_can_workspace_from_ads, write_hash_into_reduced_can_workspace,
convert_instrument_and_detector_type_to_bank_name,
convert_bank_name_to_detector_type_isis,
get_facility, parse_diagnostic_settings, get_transmission_output_name,
get_output_name, parse_event_slice_setting)
-from sans.state.data import StateData
+from sans.state.StateObjects.StateData import StateData
from sans.test_helper.test_director import TestDirector
@@ -118,51 +118,6 @@ class SANSFunctionsTest(unittest.TestCase):
# There shouldn't be an axis for angle 0
self._do_test_quaternion(angle, axis)
- def test_that_sample_log_is_added(self):
- # Arrange
- workspace = SANSFunctionsTest._create_sample_workspace()
- log_name = "TestName"
- log_value = "TestValue"
- log_type = "String"
-
- # Act
- add_to_sample_log(workspace, log_name, log_value, log_type)
-
- # Assert
- run = workspace.run()
- self.assertTrue(run.hasProperty(log_name))
- self.assertEqual(run.getProperty(log_name).value, log_value)
-
- def test_that_sample_log_raises_for_non_string_type_arguments(self):
- # Arrange
- workspace = SANSFunctionsTest._create_sample_workspace()
- log_name = "TestName"
- log_value = 123
- log_type = "String"
-
- # Act + Assert
- try:
- add_to_sample_log(workspace, log_name, log_value, log_type)
- did_raise = False
- except TypeError:
- did_raise = True
- self.assertTrue(did_raise)
-
- def test_that_sample_log_raises_for_wrong_type_selection(self):
- # Arrange
- workspace = SANSFunctionsTest._create_sample_workspace()
- log_name = "TestName"
- log_value = "test"
- log_type = "sdfsdfsdf"
-
- # Act + Assert
- try:
- add_to_sample_log(workspace, log_name, log_value, log_type)
- did_raise = False
- except ValueError:
- did_raise = True
- self.assertTrue(did_raise)
-
def test_that_unknown_reduction_mode_raises(self):
# Arrange
state = SANSFunctionsTest._get_state()
diff --git a/scripts/test/SANS/gui_logic/batch_process_runner_test.py b/scripts/test/SANS/gui_logic/batch_process_runner_test.py
index 7c6e19f041b92909eab5af1982fa60eb66f27651..13d945e5f08a7dfa2ed80e32bee83197cad618cf 100644
--- a/scripts/test/SANS/gui_logic/batch_process_runner_test.py
+++ b/scripts/test/SANS/gui_logic/batch_process_runner_test.py
@@ -32,23 +32,20 @@ class BatchProcessRunnerTest(unittest.TestCase):
self.load_mock = load_patcher.start()
self.batch_process_runner = BatchProcessRunner(self.notify_progress, self.notify_done, self.notify_error)
- self.states = {0: mock.MagicMock(), 1: mock.MagicMock(), 2: mock.MagicMock()}
+
+ self._mock_rows = [(mock.Mock(), i) for i in range(3)]
def test_that_notify_done_method_set_correctly(self):
self.batch_process_runner.notify_done()
-
self.notify_done.assert_called_once_with()
- def test_that_process_states_calls_batch_reduce_for_each_row(self):
+ def test_that_process_states_calls_batch_reduce_for_specified_row(self):
get_states_mock = mock.MagicMock()
- states = {0: mock.MagicMock(),
- 1: mock.MagicMock(),
- 2: mock.MagicMock()}
+ states = {0: mock.MagicMock()}
errors = {}
get_states_mock.return_value = states, errors
- self.batch_process_runner.process_states(self.states,
- get_thickness_for_rows_func=mock.MagicMock,
+ self.batch_process_runner.process_states(row_index_pair=self._mock_rows,
get_states_func=get_states_mock,
use_optimizations=False, output_mode=OutputMode.BOTH,
plot_results=False, output_graph='')
@@ -60,14 +57,12 @@ class BatchProcessRunnerTest(unittest.TestCase):
self.batch_process_runner.row_processed_signal = mock.MagicMock()
self.batch_process_runner.row_failed_signal = mock.MagicMock()
get_states_mock = mock.MagicMock()
- states = {0: mock.MagicMock(),
- 1: mock.MagicMock(),
- 2: mock.MagicMock()}
+
+ states = {0: mock.MagicMock()}
errors = {}
get_states_mock.return_value = states, errors
- self.batch_process_runner.process_states(self.states,
- get_thickness_for_rows_func=mock.MagicMock,
+ self.batch_process_runner.process_states(row_index_pair=self._mock_rows,
get_states_func=get_states_mock,
use_optimizations=False, output_mode=OutputMode.BOTH,
plot_results=False, output_graph='')
@@ -85,14 +80,11 @@ class BatchProcessRunnerTest(unittest.TestCase):
self.sans_batch_instance.side_effect = Exception('failure')
get_states_mock = mock.MagicMock()
- states = {0: mock.MagicMock(),
- 1: mock.MagicMock(),
- 2: mock.MagicMock()}
+ states = {0: mock.MagicMock()}
errors = {}
get_states_mock.return_value = states, errors
- self.batch_process_runner.process_states(self.states,
- get_thickness_for_rows_func=mock.MagicMock,
+ self.batch_process_runner.process_states(row_index_pair=self._mock_rows,
get_states_func=get_states_mock,
use_optimizations=False, output_mode=OutputMode.BOTH,
plot_results=False, output_graph='')
@@ -108,17 +100,12 @@ class BatchProcessRunnerTest(unittest.TestCase):
self.batch_process_runner.row_processed_signal = mock.MagicMock()
self.batch_process_runner.row_failed_signal = mock.MagicMock()
- get_thickness_func = mock.MagicMock()
-
- states = {0: mock.MagicMock(),
- 1: mock.MagicMock(),
- 2: mock.MagicMock()}
+ states = {0: mock.MagicMock()}
errors = {}
get_states_mock = mock.MagicMock()
get_states_mock.return_value = states, errors
- self.batch_process_runner.load_workspaces(self.states, get_states_func=get_states_mock,
- get_thickness_for_rows_func=get_thickness_func)
+ self.batch_process_runner.load_workspaces(row_index_pair=self._mock_rows, get_states_func=get_states_mock)
QThreadPool.globalInstance().waitForDone()
@@ -133,17 +120,12 @@ class BatchProcessRunnerTest(unittest.TestCase):
self.batch_process_runner.row_failed_signal = mock.MagicMock()
self.load_mock.side_effect = Exception('failure')
- get_thickness_func = mock.MagicMock()
-
- states = None
- errors = {0: "failure",
- 1: "failure",
- 2: "failure"}
+ states = {}
+ errors = {0: "failure"}
get_states_mock = mock.MagicMock()
get_states_mock.return_value = states, errors
- self.batch_process_runner.load_workspaces(self.states, get_states_func=get_states_mock,
- get_thickness_for_rows_func=get_thickness_func)
+ self.batch_process_runner.load_workspaces(row_index_pair=self._mock_rows, get_states_func=get_states_mock)
QThreadPool.globalInstance().waitForDone()
self.assertEqual(3, self.batch_process_runner.row_failed_signal.emit.call_count)
diff --git a/scripts/test/SANS/gui_logic/beam_centre_model_test.py b/scripts/test/SANS/gui_logic/beam_centre_model_test.py
index c1956fb50f6473e8fff3fe35b8a3f4e8630a5a3b..b919434e797633d647de64a7e15988cf7e258642 100644
--- a/scripts/test/SANS/gui_logic/beam_centre_model_test.py
+++ b/scripts/test/SANS/gui_logic/beam_centre_model_test.py
@@ -11,18 +11,16 @@ import unittest
from mantid.py3compat import mock
from sans.common.enums import FindDirectionEnum, SANSInstrument, DetectorType
from sans.gui_logic.models.beam_centre_model import BeamCentreModel
-from sans.test_helper.file_information_mock import SANSFileInformationMock
class BeamCentreModelTest(unittest.TestCase):
def setUp(self):
- self.result = {'pos1':300, 'pos2':-300}
- self.centre_finder_instance = mock.MagicMock(return_value = self.result)
- self.SANSCentreFinder = mock.MagicMock(return_value = self.centre_finder_instance)
+ self.result = {'pos1': 300, 'pos2': -300}
+ self.centre_finder_instance = mock.MagicMock(return_value=self.result)
+ self.SANSCentreFinder = mock.MagicMock(return_value=self.centre_finder_instance)
self.beam_centre_model = BeamCentreModel(self.SANSCentreFinder)
def test_that_model_initialises_with_correct_values(self):
-
self.assertEqual(self.beam_centre_model.max_iterations, 10)
self.assertEqual(self.beam_centre_model.r_min, 60)
self.assertEqual(self.beam_centre_model.r_max, 280)
@@ -43,25 +41,28 @@ class BeamCentreModelTest(unittest.TestCase):
self.assertTrue(self.beam_centre_model.update_lab)
self.assertTrue(self.beam_centre_model.update_hab)
+ def test_all_other_hardcoded_inst_values_taken(self):
+ for inst in {SANSInstrument.NO_INSTRUMENT, SANSInstrument.SANS2D, SANSInstrument.ZOOM}:
+ self.beam_centre_model.reset_inst_defaults(instrument=inst)
+ self.assertEqual(60, self.beam_centre_model.r_min)
+ self.assertEqual(280, self.beam_centre_model.r_max)
+ self.assertEqual(1000, self.beam_centre_model.scale_1)
+
+ def test_loq_values_updated(self):
+ self.beam_centre_model.reset_inst_defaults(SANSInstrument.LOQ)
+ self.assertEqual(96, self.beam_centre_model.r_min)
+ self.assertEqual(216, self.beam_centre_model.r_max)
+
def test_that_can_update_model_values(self):
self.beam_centre_model.scale_2 = 1.0
self.assertEqual(self.beam_centre_model.scale_2, 1.0)
def test_that_correct_values_are_set_for_LARMOR(self):
- file_information = SANSFileInformationMock(run_number=2260, instrument=SANSInstrument.LARMOR)
-
- self.beam_centre_model.reset_to_defaults_for_instrument(file_information)
+ self.beam_centre_model.reset_inst_defaults(instrument=SANSInstrument.LARMOR)
self.assertEqual(self.beam_centre_model.scale_1, 1.0)
- def test_that_correct_values_are_set_for_LOQ(self):
- file_information = SANSFileInformationMock(run_number=74044, instrument=SANSInstrument.LOQ)
-
- self.beam_centre_model.reset_to_defaults_for_instrument(file_information)
-
- self.assertEqual(self.beam_centre_model.r_max, 200)
-
def test_that_find_beam_centre_calls_centre_finder_once_when_COM_is_False(self):
state = mock.MagicMock()
@@ -69,7 +70,7 @@ class BeamCentreModelTest(unittest.TestCase):
self.SANSCentreFinder.return_value.assert_called_once_with(state, r_min=self.beam_centre_model.r_min,
r_max=self.beam_centre_model.r_max,
- max_iter= self.beam_centre_model.max_iterations,
+ max_iter=self.beam_centre_model.max_iterations,
x_start=self.beam_centre_model.lab_pos_1,
y_start=self.beam_centre_model.lab_pos_2,
tolerance=self.beam_centre_model.tolerance,
@@ -87,7 +88,7 @@ class BeamCentreModelTest(unittest.TestCase):
self.SANSCentreFinder.return_value.assert_called_with(state, r_min=self.beam_centre_model.r_min,
r_max=self.beam_centre_model.r_max,
- max_iter= self.beam_centre_model.max_iterations,
+ max_iter=self.beam_centre_model.max_iterations,
x_start=self.result['pos1'],
y_start=self.result['pos2'],
tolerance=self.beam_centre_model.tolerance,
diff --git a/scripts/test/SANS/gui_logic/beam_centre_presenter_test.py b/scripts/test/SANS/gui_logic/beam_centre_presenter_test.py
index 79c21a37674b8495fa72d5fb7eccf4aca0489261..ed287b01d0443efe28c9613527ddc7a5d54c75ad 100644
--- a/scripts/test/SANS/gui_logic/beam_centre_presenter_test.py
+++ b/scripts/test/SANS/gui_logic/beam_centre_presenter_test.py
@@ -13,24 +13,23 @@ from sans.common.enums import SANSInstrument
from sans.gui_logic.presenter.beam_centre_presenter import BeamCentrePresenter
from sans.test_helper.mock_objects import create_mock_beam_centre_tab
from sans.test_helper.mock_objects import (create_run_tab_presenter_mock)
+from ui.sans_isis.work_handler import WorkHandler
class BeamCentrePresenterTest(unittest.TestCase):
def setUp(self):
self.parent_presenter = create_run_tab_presenter_mock(use_fake_state = False)
- self.parent_presenter._file_information = mock.MagicMock()
- self.parent_presenter._file_information.get_instrument = mock.MagicMock(return_value = SANSInstrument.LARMOR)
self.view = create_mock_beam_centre_tab()
self.WorkHandler = mock.MagicMock()
self.BeamCentreModel = mock.MagicMock()
self.SANSCentreFinder = mock.MagicMock()
- self.presenter = BeamCentrePresenter(self.parent_presenter, self.WorkHandler, self.BeamCentreModel,
- self.SANSCentreFinder)
+ self.presenter = BeamCentrePresenter(self.parent_presenter, self.SANSCentreFinder,
+ work_handler=self.WorkHandler, beam_centre_model=self.BeamCentreModel)
self.presenter.connect_signals = mock.Mock()
+ self.presenter.set_view(self.view)
def test_that_on_run_clicked_calls_find_beam_centre(self):
- self.presenter.set_view(self.view)
self.presenter.on_run_clicked()
self.assertEqual(self.presenter._work_handler.process.call_count, 1)
@@ -50,20 +49,18 @@ class BeamCentrePresenterTest(unittest.TestCase):
self.assertEqual(self.presenter._beam_centre_model.lab_pos_1, 0.1)
self.assertEqual(self.presenter._beam_centre_model.lab_pos_2, -0.1)
- def test_that_set_options_is_called_on_update_rows(self):
- self.presenter.set_view(self.view)
-
- self.view.set_options.assert_called_once_with(self.presenter._beam_centre_model)
-
+ def test_on_update_rows_skips_no_rows(self):
+ self.parent_presenter.num_rows.return_value = 0
+ self.assertFalse(self.WorkHandler.process.called)
self.presenter.on_update_rows()
- self.assertEqual(self.view.set_options.call_count, 2)
- def test_that_model_reset_to_defaults_for_instrument_is_called_on_update_rows(self):
- self.presenter.set_view(self.view)
+ def test_reset_inst_defaults_called_on_update_rows(self):
+ self.parent_presenter.num_rows.return_value = 1
+ self.parent_presenter.instrument = SANSInstrument.SANS2D
self.presenter.on_update_rows()
- self.assertEqual(self.presenter._beam_centre_model.reset_to_defaults_for_instrument.call_count, 1)
+ self.BeamCentreModel.reset_inst_defaults.assert_called_with(SANSInstrument.SANS2D)
def test_that_set_scaling_is_called_on_update_instrument(self):
self.presenter.set_view(self.view)
diff --git a/scripts/test/SANS/gui_logic/create_state_test.py b/scripts/test/SANS/gui_logic/create_state_test.py
index 4c227422a524a32fc4e39b60ce9f93449aca3f18..a7e53ae1406f161754950dc4d77ba757f8c2c8f7 100644
--- a/scripts/test/SANS/gui_logic/create_state_test.py
+++ b/scripts/test/SANS/gui_logic/create_state_test.py
@@ -7,30 +7,23 @@
from __future__ import (absolute_import, division, print_function)
import unittest
-from qtpy.QtCore import QCoreApplication
from mantid.py3compat import mock
-from sans.common.enums import (SANSInstrument, SANSFacility, SaveType)
+from sans.common.enums import (SANSFacility, SaveType)
+from sans.gui_logic.models.RowEntries import RowEntries
from sans.gui_logic.models.create_state import (create_states, create_gui_state_from_userfile)
from sans.gui_logic.models.state_gui_model import StateGuiModel
-from sans.gui_logic.models.table_model import TableModel, TableIndexModel
-from sans.state.state import State
+from sans.state.AllStates import AllStates
+from sans.gui_logic.models.table_model import TableModel
class GuiCommonTest(unittest.TestCase):
def setUp(self):
- self.qApp = QCoreApplication(['test_app'])
- self.table_model = TableModel()
self.state_gui_model = StateGuiModel({})
- table_index_model_0 = TableIndexModel('LOQ74044', '', '', '', '', '', '', '', '', '', '', '')
- table_index_model_1 = TableIndexModel('LOQ74044', '', '', '', '', '', '', '', '', '', '', '')
- self.table_model.add_table_entry(0, table_index_model_0)
- self.table_model.add_table_entry(1, table_index_model_1)
- self.table_model.get_thickness_for_rows()
- self.table_model.wait_for_file_finding_done()
- self.qApp.processEvents()
-
- self.fake_state = mock.MagicMock(spec=State)
+ self._good_row_one = RowEntries(sample_scatter='LOQ74044')
+ self._good_row_two = RowEntries(sample_scatter='LOQ74044')
+
+ self.fake_state = mock.MagicMock(spec=AllStates)
self.gui_state_director_instance = mock.MagicMock()
self.gui_state_director_instance.create_state.return_value = self.fake_state
self.patcher = mock.patch('sans.gui_logic.models.create_state.GuiStateDirector')
@@ -39,42 +32,24 @@ class GuiCommonTest(unittest.TestCase):
self.gui_state_director.return_value = self.gui_state_director_instance
def test_create_states_returns_correct_number_of_states(self):
- states, errors = create_states(self.state_gui_model, self.table_model, SANSInstrument.LOQ, SANSFacility.ISIS,
- row_index=[0, 1])
+ rows = [self._good_row_one, self._good_row_two]
+ states, errors = create_states(self.state_gui_model, SANSFacility.ISIS, row_entries=rows)
self.assertEqual(len(states), 2)
- def test_create_states_returns_correct_number_of_states_for_specified_row_index(self):
- states, errors = create_states(self.state_gui_model, self.table_model, SANSInstrument.LOQ, SANSFacility.ISIS,
- row_index=[1])
-
- self.assertEqual(len(states), 1)
-
def test_skips_empty_rows(self):
- table_index_model = TableIndexModel('', '', '', '', '', '', '', '', '', '', '', '')
- self.table_model.add_table_entry(1, table_index_model)
- self.table_model.get_thickness_for_rows()
- self.table_model.wait_for_file_finding_done()
- self.qApp.processEvents()
-
- states, errors = create_states(self.state_gui_model, self.table_model, SANSInstrument.LOQ, SANSFacility.ISIS,
- row_index=[0, 1, 2])
-
- self.assertEqual(len(states), 2)
+ rows = [self._good_row_one, RowEntries(), self._good_row_two]
+ states, errors = create_states(self.state_gui_model, SANSFacility.ISIS, row_entries=rows)
+ self.assertEqual(2, len(states))
@mock.patch('sans.gui_logic.models.create_state.create_gui_state_from_userfile')
def test_create_state_from_user_file_if_specified(self, create_gui_state_mock):
create_gui_state_mock.returns = StateGuiModel({})
- table_index_model = TableIndexModel('LOQ74044', '', '', '', '', '', '', '', '', '', '', '',
- user_file='MaskLOQData.txt')
- table_model = TableModel()
- table_model.add_table_entry(0, table_index_model)
- table_model.get_thickness_for_rows()
- table_model.wait_for_file_finding_done()
- self.qApp.processEvents()
-
- states, errors = create_states(self.state_gui_model, table_model, SANSInstrument.LOQ, SANSFacility.ISIS,
- row_index=[0, 1, 2])
+
+ rows = [RowEntries(sample_scatter="LOQ74044", user_file="MaskLOQData.txt"),
+ RowEntries(), RowEntries()]
+
+ states, errors = create_states(self.state_gui_model, row_entries=rows, facility=SANSFacility.ISIS)
self.assertEqual(len(states), 1)
create_gui_state_mock.assert_called_once_with('MaskLOQData.txt', self.state_gui_model)
diff --git a/scripts/test/SANS/gui_logic/diagnostics_page_model_test.py b/scripts/test/SANS/gui_logic/diagnostics_page_model_test.py
index e87b465bf58691bd4ec5549b3c7cd56b6d96afe0..bb2e71f389f883cef902d51b07f1fcee1780742b 100644
--- a/scripts/test/SANS/gui_logic/diagnostics_page_model_test.py
+++ b/scripts/test/SANS/gui_logic/diagnostics_page_model_test.py
@@ -16,9 +16,6 @@ from sans.user_file.user_file_reader import UserFileReader
class DiagnosticsPageModelTest(unittest.TestCase):
- def setUp(self):
- pass
-
def test_that_create_state_creates_correct_state(self):
user_file_path = create_user_file(sample_user_file)
user_file_reader = UserFileReader(user_file_path)
diff --git a/scripts/test/SANS/gui_logic/gui_state_director_test.py b/scripts/test/SANS/gui_logic/gui_state_director_test.py
index ff597c169e38297ee352cfc057924c733be7f146..b7b25044744a4322a25c9ec36080d3b68460f19b 100644
--- a/scripts/test/SANS/gui_logic/gui_state_director_test.py
+++ b/scripts/test/SANS/gui_logic/gui_state_director_test.py
@@ -10,23 +10,22 @@ import os
import unittest
from sans.common.enums import SANSFacility
+from sans.gui_logic.models.RowEntries import RowEntries
from sans.gui_logic.models.state_gui_model import StateGuiModel
-from sans.gui_logic.models.table_model import (TableModel, TableIndexModel)
+from sans.gui_logic.models.table_model import TableModel
from sans.gui_logic.presenter.gui_state_director import GuiStateDirector
-from sans.state.state import State
+from sans.state.AllStates import AllStates
from sans.test_helper.user_file_test_helper import create_user_file, sample_user_file
from sans.user_file.user_file_reader import UserFileReader
class GuiStateDirectorTest(unittest.TestCase):
@staticmethod
- def _get_table_model(option_string="", sample_thickness=8.0):
- table_index_model = TableIndexModel("SANS2D00022024", "", "", "", "", "", "", "", "",
- "", "", "",options_column_string=option_string,
- sample_thickness=sample_thickness)
- table_model = TableModel()
- table_model.add_table_entry_no_thread_or_signal(0, table_index_model)
- return table_model
+ def _get_row_entry(option_string="", sample_thickness=8.0):
+ row_entry = RowEntries(sample_scatter="SANS2D00022024",
+ sample_thickness=sample_thickness)
+ row_entry.options.set_user_options(option_string)
+ return row_entry
@staticmethod
def _get_state_gui_model():
@@ -38,11 +37,10 @@ class GuiStateDirectorTest(unittest.TestCase):
return StateGuiModel(user_file_items)
def test_that_can_construct_state_from_models(self):
- table_model = self._get_table_model()
state_model = self._get_state_gui_model()
- director = GuiStateDirector(table_model, state_model, SANSFacility.ISIS)
- state = director.create_state(0)
- self.assertTrue(isinstance(state, State))
+ director = GuiStateDirector(state_model, SANSFacility.ISIS)
+ state = director.create_state(self._get_row_entry())
+ self.assertTrue(isinstance(state, AllStates))
try:
state.validate()
has_raised = False
@@ -53,31 +51,28 @@ class GuiStateDirectorTest(unittest.TestCase):
self.assertEqual(state.wavelength.wavelength_high, [12.5])
def test_that_will_raise_when_models_are_incomplete(self):
- table_index_model = TableIndexModel(0, "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model = TableModel()
- table_model.add_table_entry(0, table_index_model)
state_model = self._get_state_gui_model()
- director = GuiStateDirector(table_model, state_model, SANSFacility.ISIS)
- self.assertRaises(ValueError, director.create_state, 0)
+ director = GuiStateDirector(state_model, SANSFacility.ISIS)
+ with self.assertRaises(ValueError):
+ director.create_state(RowEntries())
def test_that_column_options_are_set_on_state(self):
- table_model = self._get_table_model(option_string="WavelengthMin=3.14,WavelengthMax=10.3")
state_model = self._get_state_gui_model()
- director = GuiStateDirector(table_model, state_model, SANSFacility.ISIS)
+ director = GuiStateDirector(state_model, SANSFacility.ISIS)
- state = director.create_state(0)
- self.assertTrue(isinstance(state, State))
+ row_entry = self._get_row_entry(option_string="WavelengthMin=3.14,WavelengthMax=10.3")
+ state = director.create_state(row_entry)
+ self.assertTrue(isinstance(state, AllStates))
self.assertEqual(state.wavelength.wavelength_low, [3.14])
self.assertEqual(state.wavelength.wavelength_high, [10.3])
def test_that_shift_and_scale_set_on_state_from_options_column(self):
- table_model = self._get_table_model(option_string="MergeScale=1.2,MergeShift=0.5")
state_model = self._get_state_gui_model()
- director = GuiStateDirector(table_model, state_model, SANSFacility.ISIS)
+ director = GuiStateDirector(state_model, SANSFacility.ISIS)
- state = director.create_state(0)
- self.assertTrue(isinstance(state, State))
+ state = self._get_row_entry(option_string="MergeScale=1.2,MergeShift=0.5")
+ state = director.create_state(state)
+ self.assertTrue(isinstance(state, AllStates))
self.assertEqual(state.reduction.merge_scale, 1.2)
self.assertEqual(state.reduction.merge_shift, 0.5)
diff --git a/scripts/test/SANS/gui_logic/masking_table_presenter_test.py b/scripts/test/SANS/gui_logic/masking_table_presenter_test.py
index 2eceb9d76a7000df888fa435b1b78db88306f21e..abb0bbab2a896ccea5f76f9c2406bb9e6a5858eb 100644
--- a/scripts/test/SANS/gui_logic/masking_table_presenter_test.py
+++ b/scripts/test/SANS/gui_logic/masking_table_presenter_test.py
@@ -20,16 +20,19 @@ class MaskingTablePresenterTest(unittest.TestCase):
state = presenter.get_state(3)
self.assertTrue(isinstance(state, FakeState))
- def test_that_sets_table_when_row_changes(self):
+ def test_that_sets_table_when_update_called(self):
# Arrange
parent_presenter = create_run_tab_presenter_mock(use_fake_state=False)
view = create_mock_masking_table()
presenter = MaskingTablePresenter(parent_presenter)
- # Act + Assert
+ presenter._work_handler = mock.Mock()
+
presenter.set_view(view)
- self.assertEqual(view.set_table.call_count, 1)
- presenter.on_row_changed()
- self.assertEqual(view.set_table.call_count, 2)
+
+ self.assertEqual(1, view.set_table.call_count)
+ presenter.on_display()
+
+ self.assertEqual(2, view.set_table.call_count)
first_call = mock.call([])
second_call = mock.call([masking_information(first='Beam stop', second='', third='infinite-cylinder, r = 10.0'),
masking_information(first='Corners', second='', third='infinite-cylinder, r = 20.0'),
diff --git a/scripts/test/SANS/gui_logic/model_tests/RowEntriesTest.py b/scripts/test/SANS/gui_logic/model_tests/RowEntriesTest.py
new file mode 100644
index 0000000000000000000000000000000000000000..464c975dc13298116dce0a138a97eab4ff992473
--- /dev/null
+++ b/scripts/test/SANS/gui_logic/model_tests/RowEntriesTest.py
@@ -0,0 +1,61 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+import unittest
+
+from six import iterkeys
+
+from sans.common.enums import RowState
+from sans.gui_logic.models.RowEntries import RowEntries, _UserEntries
+
+
+class RowEntriesTest(unittest.TestCase):
+ def test_settings_attr_resets_state(self):
+ observed_attrs = vars(_UserEntries())
+
+ for observed_attr in iterkeys(observed_attrs):
+ obj = RowEntries()
+ obj.state = RowState.PROCESSED
+ setattr(obj, observed_attr, "")
+
+ self.assertEqual(RowState.UNPROCESSED, obj.state,
+ "Row state did not reset for attr: {0}".format(observed_attr))
+
+ def test_non_user_keys_keep_state(self):
+ observed_attrs = ["err_msg", "state"]
+
+ for attr in observed_attrs:
+ obj = RowEntries()
+ obj.state = RowState.ERROR
+ setattr(obj, attr, RowState.ERROR)
+
+ self.assertEqual(RowState.ERROR, obj.state) # This will likely stack-overflow instead of failing
+
+ def test_is_multi_period(self):
+ multi_period_keys = ["can_direct_period", "can_scatter_period", "can_transmission_period",
+ "sample_direct_period", "sample_scatter_period", "sample_transmission_period"]
+
+ for key in multi_period_keys:
+ obj = RowEntries()
+ setattr(obj, key, 1.)
+ self.assertTrue(obj.is_multi_period())
+
+ def test_is_empty(self):
+ blank_obj = RowEntries()
+ self.assertTrue(blank_obj.is_empty(), "Default Row Entries is not blank")
+
+ for attr in iterkeys(vars(_UserEntries())):
+ obj = RowEntries()
+ setattr(obj, attr, 1.0)
+ self.assertFalse(obj.is_empty())
+
+ def test_that_state_starts_unprocessed(self):
+ obj = RowEntries()
+ self.assertEqual(RowState.UNPROCESSED, obj.state)
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/scripts/test/SANS/gui_logic/run_tab_presenter_test.py b/scripts/test/SANS/gui_logic/run_tab_presenter_test.py
index fda6911df8a2f2ea52272a0bbe03e48c08a1f853..51b93a69d932cee50f10b769bcf87f417321bb3c 100644
--- a/scripts/test/SANS/gui_logic/run_tab_presenter_test.py
+++ b/scripts/test/SANS/gui_logic/run_tab_presenter_test.py
@@ -12,47 +12,38 @@ import unittest
from mantid.kernel import PropertyManagerDataService
from mantid.kernel import config
from mantid.py3compat import mock
-from sans.common.enums import BatchReductionEntry, SANSInstrument
+from sans.command_interface.batch_csv_parser import BatchCsvParser
+from sans.common.enums import SANSInstrument
from sans.common.enums import (SANSFacility, ReductionDimensionality, SaveType, ReductionMode,
RangeStepType, FitType, RowState)
-from sans.gui_logic.models.table_model import TableModel, TableIndexModel
+from sans.gui_logic.models.RowEntries import RowEntries
+from sans.gui_logic.models.state_gui_model import StateGuiModel
+from sans.gui_logic.models.table_model import TableModel
from sans.gui_logic.presenter.run_tab_presenter import RunTabPresenter
from sans.test_helper.common import (remove_file)
from sans.test_helper.file_information_mock import SANSFileInformationMock
from sans.test_helper.mock_objects import (create_mock_view)
from sans.test_helper.user_file_test_helper import (create_user_file, sample_user_file, sample_user_file_gravity_OFF)
-BATCH_FILE_TEST_CONTENT_1 = [{BatchReductionEntry.SAMPLE_SCATTER: 1, BatchReductionEntry.SAMPLE_TRANSMISSION: 2,
- BatchReductionEntry.SAMPLE_DIRECT: 3, BatchReductionEntry.OUTPUT: 'test_file',
- BatchReductionEntry.USER_FILE: 'user_test_file'},
- {BatchReductionEntry.SAMPLE_SCATTER: 1, BatchReductionEntry.CAN_SCATTER: 2,
- BatchReductionEntry.OUTPUT: 'test_file2'}]
-
-BATCH_FILE_TEST_CONTENT_2 = [{BatchReductionEntry.SAMPLE_SCATTER: 'SANS2D00022024',
- BatchReductionEntry.SAMPLE_TRANSMISSION: 'SANS2D00022048',
- BatchReductionEntry.SAMPLE_DIRECT: 'SANS2D00022048',
- BatchReductionEntry.OUTPUT: 'test_file'},
- {BatchReductionEntry.SAMPLE_SCATTER: 'SANS2D00022024',
- BatchReductionEntry.OUTPUT: 'test_file2'}]
-
-BATCH_FILE_TEST_CONTENT_3 = [{BatchReductionEntry.SAMPLE_SCATTER: 'SANS2D00022024',
- BatchReductionEntry.SAMPLE_SCATTER_PERIOD: '3',
- BatchReductionEntry.OUTPUT: 'test_file'}]
-
-BATCH_FILE_TEST_CONTENT_4 = [{BatchReductionEntry.SAMPLE_SCATTER: 'SANS2D00022024',
- BatchReductionEntry.SAMPLE_TRANSMISSION: 'SANS2D00022048',
- BatchReductionEntry.SAMPLE_DIRECT: 'SANS2D00022048',
- BatchReductionEntry.OUTPUT: 'test_file'},
- {BatchReductionEntry.SAMPLE_SCATTER: 'SANS2D00022024',
- BatchReductionEntry.OUTPUT: 'test_file2'}]
-
-BATCH_FILE_TEST_CONTENT_5 = [{BatchReductionEntry.SAMPLE_SCATTER: 'SANS2D00022024',
- BatchReductionEntry.SAMPLE_TRANSMISSION: 'SANS2D00022048',
- BatchReductionEntry.SAMPLE_DIRECT: 'SANS2D00022048',
- BatchReductionEntry.OUTPUT: 'test_file',
- BatchReductionEntry.SAMPLE_THICKNESS: '5',
- BatchReductionEntry.SAMPLE_HEIGHT: '2',
- BatchReductionEntry.SAMPLE_WIDTH: '8'}]
+BATCH_FILE_TEST_CONTENT_1 = [RowEntries(sample_scatter=1, sample_transmission=2,
+ sample_direct=3, output_name='test_file',
+ user_file='user_test_file'),
+ RowEntries(sample_scatter=1, can_scatter=2, output_name="test_file2")]
+
+BATCH_FILE_TEST_CONTENT_2 = [RowEntries(sample_scatter='SANS2D00022024', sample_transmission='SANS2D00022048',
+ sample_direct='SANS2D00022048', output_name="test_file"),
+ RowEntries(sample_scatter='SANS2D00022024', output_name='test_file2')]
+
+BATCH_FILE_TEST_CONTENT_3 = [RowEntries(sample_scatter='SANS2D00022024', sample_scatter_period=3,
+ output_name='test_file')]
+
+BATCH_FILE_TEST_CONTENT_4 = [RowEntries(sample_scatter='SANS2D00022024', sample_transmission='SANS2D00022048',
+ sample_direct='SANS2D00022048', output_name='test_file'),
+ RowEntries(sample_scatter='SANS2D00022024', output_name='test_file2')]
+
+BATCH_FILE_TEST_CONTENT_5 = [RowEntries(sample_scatter='SANS2D00022024', sample_transmission='SANS2D00022048',
+ sample_direct='SANS2D00022048', output_name='test_file',
+ sample_thickness=5, sample_height=2, sample_width=8)]
def get_non_empty_row_mock(value):
@@ -82,13 +73,24 @@ class RunTabPresenterTest(unittest.TestCase):
config["default.facility"] = "ISIS"
- patcher = mock.patch('sans.gui_logic.presenter.run_tab_presenter.BatchCsvParser')
- self.addCleanup(patcher.stop)
- self.BatchCsvParserMock = patcher.start()
+ self._mock_model = mock.Mock(spec=StateGuiModel)
+ self._mock_table = mock.Mock(spec=TableModel)
+ self._mock_csv_parser = mock.Mock(spec=BatchCsvParser)
+ self._mock_view = mock.Mock()
+
+ # TODO, this top level presenter should not be creating sub presenters, instead we should use
+ # TODO an observer pattern and common interface to exchange messages. However for the moment
+ # TODO we will skip patching each
+ self.presenter = RunTabPresenter(SANSFacility.ISIS,
+ model=self._mock_model, table_model=self._mock_table, view=self._mock_view)
+
+ # The beam centre presenter will run QThreads which leads to flaky tests, so mock out
+ self.presenter._beam_centre_presenter = mock.Mock()
+
+ self.presenter._csv_parser = self._mock_csv_parser
+ # Allows us to use mock objs as the method tries to directly use int/floats
+ self.presenter.update_view_from_table_model = mock.Mock()
- self.os_patcher = mock.patch('sans.gui_logic.presenter.run_tab_presenter.os')
- self.addCleanup(self.os_patcher.stop)
- self.osMock = self.os_patcher.start()
def tearDown(self):
config["default.facility"] = self._backup_facility
@@ -97,15 +99,15 @@ class RunTabPresenterTest(unittest.TestCase):
config["defaultsave.directory2"] = self._backup_save_dir
def test_that_will_load_user_file(self):
- # Setup presenter and mock view
+ # Setup self.presenter.and mock view
user_file_path = create_user_file(sample_user_file)
view, settings_diagnostic_tab, _ = create_mock_view(user_file_path)
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(view)
+
+ self.presenter.set_view(view)
# Act
try:
- presenter.on_user_file_load()
+ self.presenter.on_user_file_load()
except RuntimeError:
# Assert that RuntimeError from no instrument is caught
self.fail("on_user_file_load raises a RuntimeError which should be caught")
@@ -165,158 +167,47 @@ class RunTabPresenterTest(unittest.TestCase):
self.assertEqual(view.radius_limit_max, 15.)
self.assertTrue(view.compatibility_mode)
- # Assert that Beam Centre View is updated correctly
- self.assertEqual(view.beam_centre.lab_pos_1, 155.45)
- self.assertEqual(view.beam_centre.lab_pos_2, -169.6)
- self.assertEqual(view.beam_centre.hab_pos_1, 155.45)
- self.assertEqual(view.beam_centre.hab_pos_2, -169.6)
-
# clean up
remove_file(user_file_path)
def test_that_checks_default_user_file(self):
- # Setup presenter and mock view
+ # Setup self.presenter.and mock view
view, settings_diagnostic_tab, _ = create_mock_view("")
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(view)
+
+ self.presenter.set_view(view)
self.assertEqual(
- presenter._view.set_out_default_user_file.call_count, 1,
+ self.presenter._view.set_out_default_user_file.call_count, 1,
"Expected mock to have been called once. Called {} times.".format(
- presenter._view.set_out_default_user_file.call_count))
+ self.presenter._view.set_out_default_user_file.call_count))
self.assertEqual(
- presenter._view._call_settings_listeners.call_count, 0,
+ self.presenter._view._call_settings_listeners.call_count, 0,
"Expected mock to not have been called. Called {} times.".format(
- presenter._view._call_settings_listeners.call_count))
+ self.presenter._view._call_settings_listeners.call_count))
def test_fails_silently_when_user_file_does_not_exist(self):
- self.os_patcher.stop()
view, _, _ = create_mock_view("non_existent_user_file")
+ self.presenter.set_view(view)
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(view)
-
- try:
- presenter.on_user_file_load()
- has_raised = False
- except: # noqa
- has_raised = True
- self.assertFalse(has_raised)
- self.os_patcher.start()
-
- def do_fixture_that_loads_batch_file_and_places_it_into_table(self, use_multi_period):
- # Arrange
- batch_file_path, user_file_path, presenter, view = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_2,
- is_multi_period=use_multi_period) # noqa
-
- # Act
- presenter.on_batch_file_load()
-
- # Assert
- self.assertEqual(view.add_row.call_count, 6)
- if use_multi_period:
- expected_first_row = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '',
- '', 'test_file', '', '', '', '', '', '']
- expected_second_row = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '',
- '', '', '', '', '']
- else:
- expected_first_row = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '',
- '', 'test_file', '', '', '', '', '', '']
- expected_second_row = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', ''
- , '', '', '', '']
-
- calls = [mock.call(expected_first_row), mock.call(expected_second_row)]
- view.add_row.assert_has_calls(calls)
-
- # Clean up
- self._remove_files(user_file_path=user_file_path, batch_file_path=batch_file_path)
-
- def test_that_loads_batch_file_and_places_it_into_table(self):
- self.do_fixture_that_loads_batch_file_and_places_it_into_table(use_multi_period=True)
-
- def test_that_loads_batch_file_and_places_it_into_table_when_not_multi_period_enabled(self):
- self.do_fixture_that_loads_batch_file_and_places_it_into_table(use_multi_period=False)
-
- def test_that_loads_batch_file_with_multi_period_settings(self):
- # Arrange
- batch_file_path, user_file_path, presenter, view = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_3,
- is_multi_period=False)
- # The call pattern is
- # False -- we are in single mode
- # True -- we switch to multi-period mode
- # True -- Getting table model
- # True -- Getting table model
- multi_period_mock = MultiPeriodMock(call_pattern=[False, True, True, True])
- view.is_multi_period_view = mock.MagicMock(side_effect=multi_period_mock)
-
- # Act
- presenter.on_batch_file_load()
-
- # Assert
- self.assertEqual(view.add_row.call_count, 4)
- self.assertEqual(view.show_period_columns.call_count, 2)
-
- expected_row = ['SANS2D00022024', '3', '', '', '', '', '', '', '', '', '', '', 'test_file', '', '',
- '', '', '', '']
-
- calls = [mock.call(expected_row)]
- view.add_row.assert_has_calls(calls)
-
- def test_fails_silently_when_batch_file_does_not_exist(self):
- self.os_patcher.stop()
- presenter = RunTabPresenter(SANSFacility.ISIS)
- user_file_path = create_user_file(sample_user_file)
- view, settings_diagnostic_tab, masking_table = create_mock_view(user_file_path, "non_existent_batch_file")
- presenter.set_view(view)
-
- try:
- presenter.on_batch_file_load()
- has_raised = False
- except: # noqa
- has_raised = True
- self.assertFalse(has_raised)
-
- # Clean up
- self._remove_files(user_file_path=user_file_path)
- self.os_patcher.start()
-
- def test_batch_file_dir_not_added_to_config_if_batch_file_load_fails(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- user_file_path = create_user_file(sample_user_file)
- view, settings_diagnostic_tab, masking_table = create_mock_view(user_file_path, "A/Path/batch_file.csv")
- presenter.set_view(view)
-
- presenter.on_batch_file_load()
- config_dirs = config["datasearch.directories"]
- result = "A/Path/" in config_dirs
-
- self.assertFalse(result, "We do not expect A/Path/ to be added to config, "
- "datasearch.directories is now {}".format(config_dirs))
+ self.assertIsNone(self.presenter.on_user_file_load())
def test_that_gets_states_from_view(self):
# Arrange
- batch_file_path, user_file_path, presenter, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_2)
- presenter.on_user_file_load()
- presenter.on_batch_file_load()
- presenter._table_model.update_thickness_from_file_information(1, self.get_file_information_mock())
- presenter._table_model.update_thickness_from_file_information(2, self.get_file_information_mock())
+ batch_file_path, user_file_path, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_2)
+ self.presenter.on_user_file_load()
+ self.presenter.on_batch_file_load()
# Act
- states, errors = presenter.get_states(row_index=[0, 1])
+ states, errors = self.presenter.get_states(row_entries=BATCH_FILE_TEST_CONTENT_2)
# Assert
self.assertEqual(len(states), 2)
for _, state in states.items():
- try:
- state.validate()
- has_raised = False
- except: # noqa
- has_raised = True
- self.assertFalse(has_raised)
+ state.validate()
# Check state 0
- state0 = states[0]
+ state0 = states[BATCH_FILE_TEST_CONTENT_2[0]]
self.assertEqual(state0.data.sample_scatter, "SANS2D00022024")
self.assertEqual(state0.data.sample_transmission, "SANS2D00022048")
self.assertEqual(state0.data.sample_direct, "SANS2D00022048")
@@ -325,7 +216,7 @@ class RunTabPresenterTest(unittest.TestCase):
self.assertEqual(state0.data.can_direct, None)
# Check state 1
- state1 = states[1]
+ state1 = states[BATCH_FILE_TEST_CONTENT_2[1]]
self.assertEqual(state1.data.sample_scatter, "SANS2D00022024")
self.assertEqual(state1.data.sample_transmission, None)
self.assertEqual(state1.data.sample_direct, None)
@@ -343,722 +234,369 @@ class RunTabPresenterTest(unittest.TestCase):
# Clean up
self._remove_files(user_file_path=user_file_path, batch_file_path=batch_file_path)
- def test_that_can_get_states_from_row_user_file(self):
- # Arrange
- row_user_file_path = create_user_file(sample_user_file_gravity_OFF)
- batch_file_path, user_file_path, presenter, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_4,
- row_user_file_path = row_user_file_path)
- presenter.on_user_file_load()
- presenter.on_batch_file_load()
- presenter._table_model.update_thickness_from_file_information(1, self.get_file_information_mock())
- presenter._table_model.update_thickness_from_file_information(2, self.get_file_information_mock())
-
-
- # Act
- state = presenter.get_state_for_row(1)
- state0 = presenter.get_state_for_row(0)
- # Assert
- self.assertFalse(state.convert_to_q.use_gravity)
- self.assertTrue(state0.convert_to_q.use_gravity)
-
def test_that_can_get_state_for_index_if_index_exists(self):
- # Arrange
- batch_file_path, user_file_path, presenter, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_2)
-
- presenter.on_user_file_load()
- presenter.on_batch_file_load()
- presenter._table_model.update_thickness_from_file_information(1, self.get_file_information_mock())
- presenter._table_model.update_thickness_from_file_information(2, self.get_file_information_mock())
-
- # Act
- state = presenter.get_state_for_row(1)
-
- # Assert
- self.assertEqual(state.data.sample_scatter, "SANS2D00022024")
- self.assertEqual(state.data.sample_transmission, None)
- self.assertEqual(state.data.sample_direct, None)
- self.assertEqual(state.data.can_scatter, None)
- self.assertEqual(state.data.can_transmission, None)
- self.assertEqual(state.data.can_direct, None)
-
- # Clean up
- self._remove_files(user_file_path=user_file_path, batch_file_path=batch_file_path)
+ state_key = mock.NonCallableMock()
+ self._mock_table.get_row.return_value = state_key
+ expected_states, expected_errs = {state_key: "state"}, None
+ self.presenter.get_states = mock.Mock(return_value=(expected_states, expected_errs))
+ self.presenter.sans_logger = mock.Mock()
- def test_that_returns_none_when_index_does_not_exist(self):
- # Arrange
- batch_file_path, user_file_path, presenter, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_2)
- view, _, _ = create_mock_view(user_file_path, batch_file_path)
- presenter.set_view(view)
- presenter.on_user_file_load()
- presenter.on_batch_file_load()
+ state = self.presenter.get_state_for_row(0)
- # Act
- state = presenter.get_state_for_row(3)
-
- # Assert
- self.assertEqual(state, None)
-
- # Clean up
- remove_file(batch_file_path)
- remove_file(user_file_path)
-
- def test_that_can_add_new_masks(self):
- # Arrange
- self._clear_property_manager_data_service()
- batch_file_path, user_file_path, presenter, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_2)
-
- presenter.on_user_file_load()
- presenter.on_batch_file_load()
- presenter._table_model.update_thickness_from_file_information(1, self.get_file_information_mock())
- presenter._table_model.update_thickness_from_file_information(2, self.get_file_information_mock())
-
- # Act
- presenter.on_mask_file_add()
-
- # Assert
- state = presenter.get_state_for_row(0)
- mask_info = state.mask
- mask_files = mask_info.mask_files
- self.assertEqual(mask_files, [user_file_path])
-
- # clean up
- self._remove_files(user_file_path=user_file_path, batch_file_path=batch_file_path)
+ self.assertEqual(expected_states[state_key], state)
def test_on_data_changed_calls_update_rows(self):
- batch_file_path, user_file_path, presenter, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_1)
- presenter._masking_table_presenter = mock.MagicMock()
- presenter._table_model.subscribe_to_model_changes(presenter._masking_table_presenter)
- presenter._beam_centre_presenter = mock.MagicMock()
- presenter._table_model.subscribe_to_model_changes(presenter._beam_centre_presenter)
- row_entry = [''] * 16
- presenter.on_row_inserted(0, row_entry)
+ batch_file_path, user_file_path, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_1)
+ self.presenter._masking_table_presenter = mock.MagicMock()
+ self.presenter._table_model.subscribe_to_model_changes(self.presenter._masking_table_presenter)
+ self.presenter._beam_centre_presenter = mock.MagicMock()
+ self.presenter._table_model.subscribe_to_model_changes(self.presenter._beam_centre_presenter)
- presenter.on_data_changed(0, 0, '12335', '00000')
+ updated_entries = mock.NonCallableMock()
+ self.presenter.on_data_changed(0, updated_entries)
- presenter._masking_table_presenter.on_update_rows.assert_called_with()
- presenter._beam_centre_presenter.on_update_rows.assert_called_with()
+ self.presenter._masking_table_presenter.on_update_rows.assert_called_with()
+ self.presenter._beam_centre_presenter.on_update_rows.assert_called_with()
+ self.presenter.update_view_from_table_model.assert_called_with()
def test_on_save_dir_changed_calls_set_out_file_directory(self):
- batch_file_path, user_file_path, presenter, view = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_3,
- is_multi_period=False)
+ batch_file_path, user_file_path, view = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_3,
+ is_multi_period=False)
config["defaultsave.directory"] = "test/path"
- presenter._view.set_out_file_directory.assert_called_with("test/path")
-
- def test_table_model_is_initialised_upon_presenter_creation(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- expected_table_model = TableModel()
- expected_table_model.subscribe_to_model_changes(presenter)
- expected_table_model.subscribe_to_model_changes(presenter._masking_table_presenter)
- expected_table_model.subscribe_to_model_changes(presenter._beam_centre_presenter)
- self.maxDiff = None
- self.assertEqual(presenter._table_model, expected_table_model)
+ self.presenter._view.set_out_file_directory.assert_called_with("test/path")
def test_on_insert_row_updates_table_model(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- row = ['74044', '', '74044', '', '74044', '', '74044', '', '74044', '', '74044', '', 'test_reduction'
- , 'user_file', '1.2', '']
- index = 0
- expected_table_index_model = TableIndexModel(*row)
- expected_table_index_model.id = 0
- expected_table_index_model.file_finding = False
-
- presenter.on_row_inserted(index, row)
+ self.presenter.on_row_appended()
- self.assertEqual(presenter._table_model.get_number_of_rows(), 1)
- model_row = presenter._table_model.get_table_entry(0)
- self.assertEqual(model_row, expected_table_index_model)
+ self._mock_table.append_table_entry.assert_called_with(mock.ANY)
+ self.presenter.update_view_from_table_model.assert_called_with()
def test_that_all_columns_shown_when_multi_period_is_true(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- presenter.on_multiperiod_changed(True)
+ self.presenter.set_view(mock.MagicMock())
- presenter._view.show_period_columns.assert_called_once_with()
+ self.presenter.on_multiperiod_changed(True)
+
+ self.presenter._view.show_period_columns.assert_called_once_with()
def test_that_period_columns_hidden_when_multi_period_is_false(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- presenter.on_multiperiod_changed(False)
+ self.presenter.set_view(mock.MagicMock())
+
+ self.presenter.on_multiperiod_changed(False)
- presenter._view.hide_period_columns.assert_called_once_with()
+ self.presenter._view.hide_period_columns.assert_called_once_with()
def test_on_data_changed_updates_table_model(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- row = ['74044', '', '74044', '', '74044', '', '74044', '', '74044', '', '74044', '', 'test_reduction'
- , 'user_file', '1.2', '']
- expected_row = ['74044', '', '74040', '', '74044', '', '74044', '', '74044', '', '74044', '', 'test_reduction'
- , 'user_file', '1.2', '']
- presenter._table_model.add_table_entry(0, TableIndexModel(*row))
- row = 0
- column = 2
- value = '74040'
- expected_table_index_model = TableIndexModel(*expected_row)
- expected_table_index_model.id = 0
- expected_table_index_model.file_finding = False
-
- presenter.on_data_changed(row, column, value, '')
-
- self.assertEqual(presenter._table_model.get_number_of_rows(), 1)
- model_row = presenter._table_model.get_table_entry(0)
- self.assertEqual(model_row, expected_table_index_model)
+ self.presenter._beam_centre_presenter = mock.Mock()
+ self.presenter._masking_table_presenter = mock.Mock()
+
+ expected_new_entry = mock.NonCallableMock()
+ self._mock_table.get_all_rows.return_value = [expected_new_entry]
+
+ self.presenter.on_data_changed(0, expected_new_entry)
+ self._mock_table.replace_table_entry.assert_called_with(0, expected_new_entry)
+
+ self.presenter._beam_centre_presenter.on_update_rows.assert_called_with()
+ self.presenter._masking_table_presenter.on_update_rows.assert_called_with()
+ self.presenter.update_view_from_table_model.assert_called_with()
def test_on_row_removed_removes_correct_row(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- row_0 = ['74040', '', '74040', '', '74040', '', '74040', '', '74040', '', '74040', '', 'test_reduction'
- , 'user_file', '1.2', '']
- row_1 = ['74041', '', '74041', '', '74041', '', '74041', '', '74041', '', '74041', '', 'test_reduction'
- , 'user_file', '1.2', '']
- row_2 = ['74042', '', '74042', '', '74042', '', '74042', '', '74042', '', '74042', '', 'test_reduction'
- , 'user_file', '1.2', '']
- row_3 = ['74043', '', '74043', '', '74043', '', '74043', '', '74043', '', '74043', '', 'test_reduction'
- , 'user_file', '1.2', '']
- presenter._table_model.add_table_entry(0, TableIndexModel(*row_0))
- presenter._table_model.add_table_entry(1, TableIndexModel(*row_1))
- presenter._table_model.add_table_entry(2, TableIndexModel(*row_2))
- presenter._table_model.add_table_entry(3, TableIndexModel(*row_3))
- rows = [0, 2]
- expected_row_0 = TableIndexModel(*row_1)
- expected_row_0.id = 1
- expected_row_0.file_finding = False
- expected_row_1 = TableIndexModel(*row_3)
- expected_row_1.id = 3
- expected_row_1.file_finding = False
-
- presenter.on_rows_removed(rows)
-
- self.assertEqual(presenter._table_model.get_number_of_rows(), 2)
-
- model_row_0 = presenter._table_model.get_table_entry(0)
- self.assertEqual(model_row_0, expected_row_0)
-
- model_row_1 = presenter._table_model.get_table_entry(1)
- self.assertEqual(model_row_1, expected_row_1)
-
- def test_on_rows_removed_updates_view(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- row_0 = ['74040', '', '74040', '', '74040', '', '74040', '', '74040', '', '74040', '', 'test_reduction'
- , 'user_file', '1.2', '']
- row_1 = ['74041', '', '74041', '', '74041', '', '74041', '', '74041', '', '74041', '', 'test_reduction'
- , 'user_file', '1.2', '']
- row_2 = ['74042', '', '74042', '', '74042', '', '74042', '', '74042', '', '74042', '', 'test_reduction'
- , 'user_file', '1.2', '']
- row_3 = ['74043', '', '74043', '', '74043', '', '74043', '', '74043', '', '74043', '', 'test_reduction'
- , 'user_file', '1.2', '']
- presenter._table_model.add_table_entry(0, TableIndexModel(*row_0))
- presenter._table_model.add_table_entry(1, TableIndexModel(*row_1))
- presenter._table_model.add_table_entry(2, TableIndexModel(*row_2))
- presenter._table_model.add_table_entry(3, TableIndexModel(*row_3))
- presenter.update_view_from_table_model = mock.MagicMock()
- rows = [0, 2]
-
- presenter.on_rows_removed(rows)
-
- presenter.update_view_from_table_model.assert_called_once_with()
-
- def test_add_row_to_table_model_adds_row_to_table_model(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- parsed_data = BATCH_FILE_TEST_CONTENT_2
-
- for item, row in enumerate(parsed_data):
- presenter._add_row_to_table_model(row, item)
-
- table_entry_0 = presenter._table_model.get_table_entry(0)
- self.assertEqual(table_entry_0.output_name, 'test_file')
- self.assertEqual(table_entry_0.sample_scatter, 'SANS2D00022024')
- self.assertEqual(table_entry_0.sample_thickness, '')
-
- table_entry_1 = presenter._table_model.get_table_entry(1)
- self.assertEqual(table_entry_1.output_name, 'test_file2')
-
- def test_add_row_to_table_model_adds_sample_geometries(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- parsed_data = BATCH_FILE_TEST_CONTENT_5
-
- presenter._add_row_to_table_model(parsed_data[0], 0)
-
- table_entry_0 = presenter._table_model.get_table_entry(0)
- self.assertEqual(table_entry_0.sample_thickness, '5')
- self.assertEqual(table_entry_0.sample_height, '2')
- self.assertEqual(table_entry_0.sample_width, '8')
-
- def test_update_view_from_table_model_updated_view_based_on_model(self):
- batch_file_path, user_file_path, presenter, _ = self._get_files_and_mock_presenter(BATCH_FILE_TEST_CONTENT_2)
- presenter.set_view(mock.MagicMock())
- parsed_data = BATCH_FILE_TEST_CONTENT_2
- for item, row in enumerate(parsed_data):
- presenter._add_row_to_table_model(row, item)
- expected_call_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '', '', '', '', '']
- expected_call_1 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', '', '',
- '', '', '']
-
- presenter.update_view_from_table_model()
-
- self.assertEqual(presenter._view.add_row.call_count, 5)
-
- presenter._view.add_row.assert_any_call(expected_call_0)
- presenter._view.add_row.assert_any_call(expected_call_1)
+ rows = [0]
+ self.presenter.on_rows_removed(rows)
+
+ self._mock_table.remove_table_entries.assert_called_with(rows)
+ self.presenter.update_view_from_table_model.assert_called_with()
def test_setup_instrument_specific_settings(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- presenter._beam_centre_presenter = mock.MagicMock()
- presenter._workspace_diagnostic_presenter = mock.MagicMock()
+
+ self.presenter.set_view(mock.MagicMock())
+ self.presenter._beam_centre_presenter = mock.MagicMock()
+ self.presenter._workspace_diagnostic_presenter = mock.MagicMock()
instrument = SANSInstrument.LOQ
- presenter._setup_instrument_specific_settings(SANSInstrument.LOQ)
+ self.presenter._setup_instrument_specific_settings(SANSInstrument.LOQ)
- presenter._view.set_instrument_settings.called_once_with(instrument)
- presenter._beam_centre_presenter.on_update_instrument.called_once_with(instrument)
- presenter._workspace_diagnostic_presenter.called_once_with(instrument)
+ self.presenter._view.set_instrument_settings.called_once_with(instrument)
+ self.presenter._beam_centre_presenter.on_update_instrument.called_once_with(instrument)
+ self.presenter._workspace_diagnostic_presenter.called_once_with(instrument)
def test_setup_instrument_specific_settings_sets_facility_in_config(self):
config.setFacility('TEST_LIVE')
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- presenter._beam_centre_presenter = mock.MagicMock()
- presenter._workspace_diagnostic_presenter = mock.MagicMock()
+
+ self.presenter.set_view(mock.MagicMock())
+ self.presenter._beam_centre_presenter = mock.MagicMock()
+ self.presenter._workspace_diagnostic_presenter = mock.MagicMock()
instrument = SANSInstrument.LOQ
- presenter._setup_instrument_specific_settings(instrument)
+ self.presenter._setup_instrument_specific_settings(instrument)
self.assertEqual(config.getFacility().name(), 'ISIS')
def test_setup_instrument_specific_settings_sets_instrument_in_config(self):
config['default.instrument'] = 'ALF'
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(mock.MagicMock())
- presenter._beam_centre_presenter = mock.MagicMock()
- presenter._workspace_diagnostic_presenter = mock.MagicMock()
+
+ self.presenter.set_view(mock.MagicMock())
+ self.presenter._beam_centre_presenter = mock.MagicMock()
+ self.presenter._workspace_diagnostic_presenter = mock.MagicMock()
instrument = SANSInstrument.LOQ
- presenter._setup_instrument_specific_settings(instrument)
+ self.presenter._setup_instrument_specific_settings(instrument)
self.assertEqual(config['default.instrument'], 'LOQ')
def test_on_copy_rows_requested_adds_correct_rows_to_clipboard(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0])
- presenter.set_view(view)
- test_row = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
-
- presenter.on_row_inserted(0, test_row)
+ self._mock_view.get_selected_rows.return_value = [0]
+ expected_clipboard = mock.NonCallableMock()
+ self._mock_table.get_row.return_value = expected_clipboard
- presenter.on_copy_rows_requested()
+ self.presenter.on_copy_rows_requested()
- self.assertEqual(presenter._clipboard, [test_row])
+ self.assertTrue(expected_clipboard in self.presenter._clipboard)
def test_on_paste_rows_requested_appends_new_row_if_no_row_selected(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
- test_row_1 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', '1.0', '',
- '', '', '']
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_1)
- presenter._clipboard = [test_row_0]
+ self._mock_view.get_selected_rows.return_value = []
+ pos = 101
+ self._mock_table.get_number_of_rows.return_value = pos
+
+ expected = mock.NonCallableMock()
+ self.presenter._clipboard = [expected]
+ self.presenter.update_view_from_table_model = mock.MagicMock()
- presenter.on_paste_rows_requested()
+ self.presenter.on_paste_rows_requested()
- self.assertEqual(presenter._table_model.get_number_of_rows(), 3)
- self.assertEqual(presenter._table_model.get_table_entry(2).to_list(), test_row_0)
+ self.presenter.update_view_from_table_model.assert_called_with()
+ self._mock_table.replace_table_entries.assert_called_with([pos], [expected])
def test_on_paste_rows_requested_replaces_row_if_one_row_is_selected(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[1])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
- test_row_1 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', '1.0', '',
- '', '', '']
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_1)
- presenter.on_row_inserted(2, test_row_0)
- presenter._clipboard = [test_row_0]
-
- presenter.on_paste_rows_requested()
-
- self.assertEqual(presenter._table_model.get_number_of_rows(), 3)
- self.assertEqual(presenter._table_model.get_table_entry(1).to_list(), test_row_0)
+ pos = [1]
+ self._mock_view.get_selected_rows.return_value = pos
+
+ test_row_0 = mock.NonCallableMock()
+ self.presenter._clipboard = [test_row_0]
+ self.presenter.update_view_from_table_model = mock.MagicMock()
+
+ self.presenter.on_paste_rows_requested()
+
+ self.presenter.update_view_from_table_model.assert_called_with()
+ self._mock_table.replace_table_entries.assert_called_with(pos, [test_row_0])
def test_on_paste_rows_requested_replaces_first_row_and_removes_rest_if_multiple_rows_selected(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0, 2])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
- test_row_1 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', '1.0', '',
- '', '', '']
- test_row_2 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file3', '', '1.0', '',
- '', '', '']
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_1)
- presenter.on_row_inserted(2, test_row_2)
- presenter._clipboard = [test_row_2]
-
- presenter.on_paste_rows_requested()
-
- self.assertEqual(presenter._table_model.get_number_of_rows(), 2)
- self.assertEqual(presenter._table_model.get_table_entry(0).to_list(), test_row_2)
- self.assertEqual(presenter._table_model.get_table_entry(1).to_list(), test_row_1)
-
- def test_on_paste_rows_updates_table_in_view(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '']
- test_row_1 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', '1.0', '']
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_1)
- presenter._clipboard = [test_row_0]
- presenter.update_view_from_table_model = mock.MagicMock()
+ expected_pos = [0, 2]
+ self._mock_view.get_selected_rows.return_value = expected_pos
+
+ expected = mock.NonCallableMock()
+ self.presenter._clipboard = [expected]
+ self.presenter.update_view_from_table_model = mock.MagicMock()
- presenter.on_paste_rows_requested()
+ self.presenter.on_paste_rows_requested()
- presenter.update_view_from_table_model.assert_called_with()
+ self.presenter.update_view_from_table_model.assert_called_with()
+ self._mock_table.replace_table_entries.assert_called_with(expected_pos, [expected])
def test_on_insert_row_adds_row_to_table_model_after_selected_row(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
- test_row_1 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', '1.0', '',
- '', '', '']
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_1)
-
- presenter.on_insert_row()
-
- self.assertEqual(presenter._table_model.get_number_of_rows(), 3)
- self.assertEqual(presenter._table_model.get_table_entry(1).to_list(), [''] * 19)
- self.assertEqual(presenter._table_model.get_table_entry(0).to_list(), test_row_0)
- self.assertEqual(presenter._table_model.get_table_entry(2).to_list(), test_row_1)
+ self._mock_view.get_selected_rows.return_value = [100]
+
+ self.presenter.on_insert_row()
+
+ self._mock_table.insert_row_at(101, mock.ANY)
+ self.presenter.update_view_from_table_model.assert_called_with()
def test_on_insert_row_updates_view(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
- test_row_1 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', '1.0',
- '', '', '', '']
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_1)
- presenter.update_view_from_table_model = mock.MagicMock()
-
- presenter.on_insert_row()
-
- presenter.update_view_from_table_model.assert_called_once_with()
-
- def test_on_erase_rows_clears_rows_from_table_model(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[1, 2])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
- empty_row = TableModel.create_empty_row()
-
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_0)
- presenter.on_row_inserted(2, test_row_0)
-
- presenter.on_erase_rows()
-
- self.assertEqual(presenter._table_model.get_number_of_rows(), 3)
- self.assertEqual(presenter._table_model.get_table_entry(0).to_list(), test_row_0)
- empty_row.id = 3
- self.assertEqual(presenter._table_model.get_table_entry(1).__dict__, empty_row.__dict__)
- empty_row.id = 4
- self.assertEqual(presenter._table_model.get_table_entry(2).__dict__, empty_row.__dict__)
-
- def test_on_erase_rows_does_not_add_rows_when_table_contains_one_row(self):
- """
- A bug caused erase rows to add a row to a table containing only 1 row.
- Check that this is fixed
- """
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0])
- presenter.set_view(view)
+ self._mock_view.get_selected_rows.return_value = [0]
- test_row = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
+ self.presenter.on_insert_row()
+ self.presenter.update_view_from_table_model.assert_called_once_with()
- presenter.on_row_inserted(0, test_row)
- presenter.on_erase_rows()
+ def test_on_erase_rows_clears_specific_rows_from_table_model(self):
+ selected_rows = [1, 2]
+ self._mock_table.get_number_of_rows.return_value = 3
+ self._mock_view.get_selected_rows.return_value = selected_rows
- self.assertEqual(presenter._table_model.get_number_of_rows(), 1)
- self.assertEqual(presenter._table_model.get_table_entry(0).to_list(), ['']*19)
+ self.presenter.on_erase_rows()
+ self.assertEqual(len(selected_rows), self._mock_table.replace_table_entries.call_count)
+ self.presenter.update_view_from_table_model.assert_called_with()
- def test_on_erase_rows_updates_view(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[1, 2])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_0)
- presenter.on_row_inserted(2, test_row_0)
- presenter.update_view_from_table_model = mock.MagicMock()
-
- presenter.on_erase_rows()
-
- self.assertEqual(presenter._table_model._table_entries[0].to_list(),
- ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', ''])
- self.assertEqual(presenter._table_model._table_entries[1].to_list(),
- ['', '', '', '', '', '', '', '', '', '', '', '',
- '', '', '', '', '', '', ''])
- self.assertEqual(presenter._table_model._table_entries[2].to_list(),
- ['', '', '', '', '', '', '', '', '', '', '', '',
- '', '', '', '', '', '', ''])
+ def test_on_erase_rows_clears_table(self):
+ selected_rows = [0, 1, 2]
+ self._mock_table.get_number_of_rows.return_value = 3
+ self._mock_view.get_selected_rows.return_value = selected_rows
- def test_on_cut_rows_requested_updates_clipboard(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0])
- presenter.set_view(view)
- test_row = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
+ self.presenter.on_erase_rows()
+
+ self._mock_table.clear_table_entries.assert_called_with()
- presenter.on_row_inserted(0, test_row)
+ self._mock_view.get_selected_rows.return_value = []
+ self._mock_table.clear_table_entries.reset_mock()
- presenter.on_cut_rows_requested()
+ self.presenter.on_erase_rows()
+ self._mock_table.clear_table_entries.assert_called_with()
+ self.presenter.update_view_from_table_model.assert_called_with()
+
+ def test_on_cut_rows_requested_updates_clipboard(self):
+ self._mock_view.get_selected_rows.return_value = [0]
+ expected_clipboard = mock.NonCallableMock()
+ self._mock_table.get_row.return_value = expected_clipboard
- self.assertEqual(presenter._clipboard, [test_row])
+ self.presenter.on_cut_rows_requested()
+
+ self.assertTrue(expected_clipboard in self.presenter._clipboard)
def test_on_cut_rows_requested_removes_selected_rows(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0])
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '', '', '', '']
- test_row_1 = ['SANS2D00022024', '', '', '', '', '', '', '', '', '', '', '', 'test_file2', '', '1.0',
- '', '', '', '']
- presenter.on_row_inserted(0, test_row_0)
- presenter.on_row_inserted(1, test_row_1)
+ selected_rows = [0]
+ self._mock_view.get_selected_rows.return_value = selected_rows
- presenter.on_cut_rows_requested()
+ expected = "expected_clipboard_val"
+ self._mock_table.get_row.return_value = expected
- self.assertEqual(presenter._table_model.get_number_of_rows(), 1)
- self.assertEqual(presenter._table_model.get_table_entry(0).to_list(), test_row_1)
+ self.presenter.on_cut_rows_requested()
- def test_notify_progress_increments_progress(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '']
- presenter.on_row_inserted(0, test_row_0)
+ self._mock_table.remove_table_entries.assert_called_with(selected_rows)
+ self.assertTrue(expected in self.presenter._clipboard)
- presenter.notify_progress(0, [0.0], [1.0])
+ def test_notify_progress_increments_progress(self):
+ self.presenter.notify_progress(0, [0.0], [1.0])
- self.assertEqual(presenter.progress, 1)
- self.assertEqual(presenter._view.progress_bar_value, 1)
+ self.assertEqual(self.presenter.progress, 1)
+ self.assertEqual(self.presenter._view.progress_bar_value, 1)
def test_that_notify_progress_updates_state_and_tooltip_of_row_for_scale_and_shift(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '']
- presenter.on_row_inserted(0, test_row_0)
+ mocked_row = mock.Mock()
+
+ self._mock_table.get_row.return_value = mocked_row
- presenter.notify_progress(0, [0.0], [1.0])
+ self.presenter.notify_progress(0, [0.0], [1.0])
- self.assertEqual(presenter._table_model.get_table_entry(0).row_state, RowState.PROCESSED)
- self.assertEqual(presenter._table_model.get_table_entry(0).options_column_model.get_options_string(),
- 'MergeScale=1.0, MergeShift=0.0')
+ self.assertEqual(RowState.PROCESSED, mocked_row.state)
+ self.assertIsNone(mocked_row.tool_tip)
- self.assertEqual(presenter.progress, 1)
- self.assertEqual(presenter._view.progress_bar_value, 1)
+ mocked_row.options.set_developer_option.assert_called_with('MergeShift', 0.0)
+
+ self.assertEqual(self.presenter.progress, 1)
+ self.assertEqual(self.presenter._view.progress_bar_value, 1)
def test_that_update_progress_sets_correctly(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
- presenter.set_view(view)
+ self.presenter.set_view(view)
- presenter._set_progress_bar(current=100, number_steps=200)
- self.assertEqual(presenter.progress, 100)
+ self.presenter._set_progress_bar(current=100, number_steps=200)
+ self.assertEqual(self.presenter.progress, 100)
self.assertEqual(view.progress_bar_value, 100)
self.assertEqual(view.progress_bar_maximum, 200)
def test_that_notify_progress_updates_state_and_tooltip_of_row(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
- presenter.set_view(view)
- test_row_0 = ['SANS2D00022024', '', 'SANS2D00022048', '', 'SANS2D00022048', '', '', '', '', '', '', '',
- 'test_file', '', '1.0', '']
- presenter.on_row_inserted(0, test_row_0)
+ self.presenter.set_view(view)
+ self.presenter.on_row_appended()
- presenter.notify_progress(0, [], [])
+ self.presenter.notify_progress(0, [], [])
- self.assertEqual(presenter._table_model.get_table_entry(0).row_state, RowState.PROCESSED)
- self.assertEqual(presenter._table_model.get_table_entry(0).tool_tip, '')
+ self.assertEqual(self.presenter._table_model.get_row(0).state, RowState.PROCESSED)
+ self.assertEqual(self.presenter._table_model.get_row(0).tool_tip, None)
def test_that_process_selected_does_nothing_if_no_states_selected(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
view.get_selected_rows = mock.MagicMock(return_value=[])
- presenter.set_view(view)
- presenter._process_rows = mock.MagicMock()
+ self.presenter.set_view(view)
+ self.presenter._process_rows = mock.MagicMock()
- presenter.on_process_selected_clicked()
+ self.presenter.on_process_selected_clicked()
self.assertEqual(
- presenter._process_rows.call_count, 0,
- "Expected presenter._process_rows to not have been called. Called {} times.".format(
- presenter._process_rows.call_count))
+ self.presenter._process_rows.call_count, 0,
+ "Expected self.presenter._process_rows to not have been called. Called {} times.".format(
+ self.presenter._process_rows.call_count))
def test_that_process_selected_only_processes_selected_rows(self):
# Naive test. Doesn't check that we are processing the correct processed rows,
# just that we are processing the same number of rows as we have selected.
- # This would only really fail if on_process_selected_clicked and on_process_all_clicked
+ # This would only really fail if on_process_selected_clicked and on_process_all_clicked
# get muddled-up
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0, 3, 4])
- # Suppress plots
- view.plot_results = False
-
- presenter.set_view(view)
- presenter._table_model.reset_row_state = mock.MagicMock()
- presenter._table_model.get_thickness_for_rows = mock.MagicMock()
- presenter._table_model.get_non_empty_rows = mock.MagicMock(side_effect=get_non_empty_row_mock)
-
- presenter.on_process_selected_clicked()
- self.assertEqual(
- presenter._table_model.reset_row_state.call_count, 3,
- "Expected reset_row_state to have been called 3 times. Called {} times.".format(
- presenter._table_model.reset_row_state.call_count))
+ view.get_selected_rows = mock.MagicMock(return_value=[0, 2, 3])
+
+ self.presenter.set_view(view)
+ self.presenter._process_rows = mock.Mock()
+
+ table_model = TableModel()
+
+ for i in range(5):
+ table_model.append_table_entry(RowEntries(sample_scatter='74040'))
+ self.presenter._table_model = table_model
+
+ self.presenter.on_process_selected_clicked()
+
+ expected = [table_model.get_row(0), table_model.get_row(2), table_model.get_row(3)]
+
+ self.presenter._process_rows.assert_called_with(expected)
def test_that_process_selected_ignores_all_empty_rows(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
view.get_selected_rows = mock.MagicMock(return_value=[0, 1])
- presenter.set_view(view)
+ self.presenter.set_view(view)
table_model = TableModel()
- row_entry0 = [''] * 16
- row_entry1 = ['74040', '', '74040', '', '74040', '', '74040', '', '74040', '', '74040', '', 'test_reduction',
- 'user_file', '1.2', '']
- table_model.add_table_entry(0, TableIndexModel(*row_entry0))
- table_model.add_table_entry(1, TableIndexModel(*row_entry1))
-
- presenter._table_model = table_model
- presenter._process_rows = mock.MagicMock()
-
- presenter.on_process_selected_clicked()
- presenter._process_rows.assert_called_with([1])
-
- def test_that_process_all_ignores_selected_rows(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- view.get_selected_rows = mock.MagicMock(return_value=[0, 3, 4])
-
- # Suppress plots
- view.plot_results = False
-
- presenter._table_model.get_number_of_rows = mock.MagicMock(return_value=7)
- presenter.set_view(view)
- presenter._table_model.reset_row_state = mock.MagicMock()
- presenter._table_model.get_thickness_for_rows = mock.MagicMock()
- presenter._table_model.get_non_empty_rows = mock.MagicMock(side_effect=get_non_empty_row_mock)
-
- presenter.on_process_all_clicked()
- self.assertEqual(
- presenter._table_model.reset_row_state.call_count, 7,
- "Expected reset_row_state to have been called 7 times. Called {} times.".format(
- presenter._table_model.reset_row_state.call_count))
+ empty_row = RowEntries()
+ populated_row = RowEntries(sample_scatter='74040')
- def test_that_process_all_ignores_empty_rows(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
+ table_model.replace_table_entry(0, empty_row)
+ table_model.replace_table_entry(1, populated_row)
- table_model = TableModel()
- row_entry0 = [''] * 16
- row_entry1 = ['74040', '', '74040', '', '74040', '', '74040', '', '74040', '', '74040', '', 'test_reduction',
- 'user_file', '1.2', '']
- table_model.add_table_entry(0, TableIndexModel(*row_entry0))
- table_model.add_table_entry(1, TableIndexModel(*row_entry1))
+ self.presenter._table_model = table_model
+ self.presenter._process_rows = mock.MagicMock()
- presenter._table_model = table_model
- presenter._process_rows = mock.MagicMock()
+ self.presenter.on_process_selected_clicked()
+ self.presenter._process_rows.assert_called_with([populated_row])
- presenter.on_process_all_clicked()
- presenter._process_rows.assert_called_with([1])
+ def test_that_process_all_ignores_empty_rows(self):
- def test_that_table_not_exported_if_table_is_empty(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
view = mock.MagicMock()
- presenter.set_view(view)
+ view.get_selected_rows = mock.MagicMock(return_value=[0, 1])
+ self.presenter.set_view(view)
- presenter._export_table = mock.MagicMock()
+ table_model = TableModel()
+ populated_row = RowEntries(sample_scatter=1)
+ table_model.append_table_entry(populated_row)
+ table_model.append_table_entry(RowEntries())
- presenter.on_export_table_clicked()
- self.assertEqual(presenter._export_table.call_count, 0,
- "_export table should not have been called."
- " It was called {} times.".format(presenter._export_table.call_count))
+ self.presenter._table_model = table_model
+ self.presenter._process_rows = mock.MagicMock()
- def test_row_created_for_batch_file_correctly(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- presenter.set_view(view)
+ self.presenter.on_process_selected_clicked()
+ self.presenter._process_rows.assert_called_with([populated_row])
- test_row = ["SANS2D00022025", "SANS2D00022052", "SANS2D00022022",
- "", "", "", "another_file", "a_user_file.txt", "1.0", "5.0", "5.4"]
+ def test_that_table_not_exported_if_table_is_empty(self):
+ self.presenter._export_table = mock.MagicMock()
+ self._mock_table.get_non_empty_rows.return_value = []
- expected_list = ["sample_sans", "SANS2D00022025", "sample_trans", "SANS2D00022052",
- "sample_direct_beam", "SANS2D00022022", "can_sans", "", "can_trans", "", "can_direct_beam", "",
- "output_as", "another_file", "user_file", "a_user_file.txt", "sample_thickness", "1.0",
- "sample_height", "5.0", "sample_width", "5.4"]
+ self.presenter.on_export_table_clicked()
+ self.assertEqual(self.presenter._export_table.call_count, 0,
+ "_export table should not have been called."
+ " It was called {} times.".format(self.presenter._export_table.call_count))
- actual_list = presenter._create_batch_entry_from_row(test_row)
+ def test_buttons_enabled_after_export_table_fails(self):
+ self._mock_table.get_non_empty_rows.return_value = [RowEntries()]
+ self._mock_table.batch_file = ""
- self.assertEqual(actual_list, expected_list)
+ self.presenter.display_save_file_box = mock.Mock(return_value="mocked_file_path")
- def test_buttons_enabled_after_export_table_fails(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- view = mock.MagicMock()
- presenter.set_view(view)
+ self.presenter._view.enable_buttons = mock.Mock()
+ self.presenter._view.disable_buttons = mock.Mock()
- presenter.get_row_indices = mock.MagicMock(return_value=[0, 1, 2])
- presenter._view.enable_buttons = mock.MagicMock()
# Mock error throw on disable buttons so export fails
- presenter._view.disable_buttons = mock.MagicMock(side_effect=RuntimeError("A test exception"))
- try:
- presenter.on_export_table_clicked()
- except Exception as e:
- self.fail("Exceptions should have been caught in the method. "
- "Exception thrown is {}".format(str(e)))
- else:
- self.assertEqual(presenter._view.enable_buttons.call_count, 1,
- "Expected enable buttons to be called once, "
- "was called {} times.".format(presenter._view.enable_buttons.call_count))
+ self.presenter._csv_parser = mock.Mock()
+ self.presenter._csv_parser.save_batch_file = mock.Mock(side_effect=RuntimeError(""))
+
+ with self.assertRaises(RuntimeError):
+ self.presenter.on_export_table_clicked()
+
+ self.assertEqual(self.presenter._view.enable_buttons.call_count, 1)
def test_that_canSAS_is_disabled_if_2D_reduction(self):
"""This test checks that if you are running a 2D reduction and have canSAS output mode checked,
the GUI will automatically uncheck canSAS to avoid data dimension errors."""
- presenter = RunTabPresenter(SANSFacility.ISIS)
view = mock.MagicMock()
view.can_sas_checkbox.isChecked = mock.Mock(return_value=True)
@@ -1066,13 +604,12 @@ class RunTabPresenterTest(unittest.TestCase):
view.can_sas_checkbox.setEnabled = mock.Mock()
view.output_mode_memory_radio_button.isChecked = mock.Mock(return_value=False)
- presenter.set_view(view)
- presenter.on_reduction_dimensionality_changed(False)
- presenter._view.can_sas_checkbox.setEnabled.assert_called_once_with(False)
+ self.presenter.set_view(view)
+ self.presenter.on_reduction_dimensionality_changed(False)
+ self.presenter._view.can_sas_checkbox.setEnabled.assert_called_once_with(False)
def test_that_canSAS_is_unchecked_if_2D_reduction(self):
"""This tests that the canSAS checkbox is unchecked when switching from 1D to 2D reduction"""
- presenter = RunTabPresenter(SANSFacility.ISIS)
view = mock.MagicMock()
view.can_sas_checkbox.isChecked = mock.Mock(return_value=True)
@@ -1080,14 +617,13 @@ class RunTabPresenterTest(unittest.TestCase):
view.can_sas_checkbox.setEnabled = mock.Mock()
view.output_mode_memory_radio_button.isChecked = mock.Mock(return_value=False)
- presenter.set_view(view)
- presenter.on_reduction_dimensionality_changed(False)
- presenter._view.can_sas_checkbox.setChecked.assert_called_once_with(False)
+ self.presenter.set_view(view)
+ self.presenter.on_reduction_dimensionality_changed(False)
+ self.presenter._view.can_sas_checkbox.setChecked.assert_called_once_with(False)
def test_that_canSAS_is_enabled_if_1D_reduction_and_not_in_memory_mode(self):
"""This test checks that if you are not in memory mode and switch to 1D reduction, then
can sas file type is enabled."""
- presenter = RunTabPresenter(SANSFacility.ISIS)
view = mock.MagicMock()
view.can_sas_checkbox.isChecked = mock.Mock(return_value=True)
@@ -1095,16 +631,15 @@ class RunTabPresenterTest(unittest.TestCase):
view.can_sas_checkbox.setEnabled = mock.Mock()
view.output_mode_memory_radio_button.isChecked = mock.Mock(return_value=False)
- presenter.set_view(view)
- presenter.on_reduction_dimensionality_changed(True)
+ self.presenter.set_view(view)
+ self.presenter.on_reduction_dimensionality_changed(True)
- presenter._view.can_sas_checkbox.setEnabled.assert_called_once_with(True)
- presenter._view.can_sas_checkbox.setChecked.assert_not_called()
+ self.presenter._view.can_sas_checkbox.setEnabled.assert_called_once_with(True)
+ self.presenter._view.can_sas_checkbox.setChecked.assert_not_called()
def test_that_canSAS_is_not_enabled_if_switch_to_1D_reduction_and_in_memory_mode(self):
"""This test checks that if you are in memory mode, the can sas file type is not
re-enabled if you switch to 1D reduction."""
- presenter = RunTabPresenter(SANSFacility.ISIS)
view = mock.MagicMock()
view.can_sas_checkbox.isChecked = mock.Mock(return_value=True)
@@ -1112,24 +647,24 @@ class RunTabPresenterTest(unittest.TestCase):
view.can_sas_checkbox.setEnabled = mock.Mock()
view.output_mode_memory_radio_button.isChecked = mock.Mock(return_value=True)
- presenter.set_view(view)
- presenter.on_reduction_dimensionality_changed(True)
+ self.presenter.set_view(view)
+ self.presenter.on_reduction_dimensionality_changed(True)
- presenter._view.can_sas_checkbox.setChecked.assert_not_called()
- presenter._view.can_sas_checkbox.setEnabled.assert_not_called()
+ self.presenter._view.can_sas_checkbox.setChecked.assert_not_called()
+ self.presenter._view.can_sas_checkbox.setEnabled.assert_not_called()
def test_that_updating_default_save_directory_also_updates_add_runs_save_directory(self):
- """This test checks that add runs presenter's save directory update method is called
+ """This test checks that add runs self.presenter.s save directory update method is called
when the defaultsave directory is updated."""
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
- presenter.set_view(view)
+ self.presenter.set_view(view)
- presenter._handle_output_directory_changed("a_new_directory")
- presenter._view.add_runs_presenter.handle_new_save_directory.assert_called_once_with("a_new_directory")
+ self.presenter._handle_output_directory_changed("a_new_directory")
+ self.presenter._view.add_runs_presenter.handle_new_save_directory.assert_called_once_with("a_new_directory")
def test_that_validate_output_modes_raises_if_no_file_types_selected_for_file_mode(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
view.save_types = [SaveType.NO_TYPE]
@@ -1137,12 +672,12 @@ class RunTabPresenterTest(unittest.TestCase):
view.output_mode_memory_radio_button.isChecked = mock.MagicMock(return_value=False)
view.output_mode_file_radio_button.isChecked = mock.MagicMock(return_value=True)
view.output_mode_both_radio_button.isChecked = mock.MagicMock(return_value=False)
- presenter.set_view(view)
+ self.presenter.set_view(view)
- self.assertRaises(RuntimeError, presenter._validate_output_modes)
+ self.assertRaises(RuntimeError, self.presenter._validate_output_modes)
def test_that_validate_output_modes_raises_if_no_file_types_selected_for_both_mode(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
view.save_types = [SaveType.NO_TYPE]
@@ -1150,43 +685,43 @@ class RunTabPresenterTest(unittest.TestCase):
view.output_mode_memory_radio_button.isChecked = mock.MagicMock(return_value=False)
view.output_mode_file_radio_button.isChecked = mock.MagicMock(return_value=False)
view.output_mode_both_radio_button.isChecked = mock.MagicMock(return_value=True)
- presenter.set_view(view)
+ self.presenter.set_view(view)
- self.assertRaises(RuntimeError, presenter._validate_output_modes)
+ self.assertRaises(RuntimeError, self.presenter._validate_output_modes)
def test_that_validate_output_modes_does_not_raise_if_no_file_types_selected_for_memory_mode(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
view.save_types = [SaveType.NO_TYPE]
view.output_mode_memory_radio_button.isChecked = mock.Mock(return_value=True)
view.output_mode_file_radio_button.isChecked = mock.Mock(return_value=False)
view.output_mode_both_radio_button.isChecked = mock.Mock(return_value=False)
- presenter.set_view(view)
+ self.presenter.set_view(view)
try:
- presenter._validate_output_modes()
+ self.presenter._validate_output_modes()
except RuntimeError:
self.fail("Did not expect _validate_output_modes to fail when no file types are selected "
"for memory output mode.")
def test_that_switching_to_memory_mode_disables_all_file_type_buttons(self):
"""This tests that all file type buttons are disabled when memory mode is selected."""
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
view.output_mode_memory_radio_button.isChecked = mock.Mock(return_value=True)
view.disable_file_type_buttons = mock.Mock()
- presenter.set_view(view)
+ self.presenter.set_view(view)
- presenter.on_output_mode_changed()
- presenter._view.disable_file_type_buttons.assert_called_once_with()
+ self.presenter.on_output_mode_changed()
+ self.presenter._view.disable_file_type_buttons.assert_called_once_with()
def test_that_all_file_type_buttons_are_enabled_if_switching_to_non_memory_mode_and_in_1D_reduction_mode(self):
"""This tests that all file type buttons are enabled if switching to file or both mode, when reduction
dimensionality is 1D"""
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
view.output_mode_memory_radio_button.isChecked = mock.Mock(return_value=False)
@@ -1195,17 +730,17 @@ class RunTabPresenterTest(unittest.TestCase):
view.nx_can_sas_checkbox.setEnabled = mock.Mock()
view.rkh_checkbox.setEnabled = mock.Mock()
- presenter.set_view(view)
+ self.presenter.set_view(view)
- presenter.on_output_mode_changed()
- presenter._view.can_sas_checkbox.setEnabled.assert_called_once_with(True)
- presenter._view.nx_can_sas_checkbox.setEnabled.assert_called_once_with(True)
- presenter._view.rkh_checkbox.setEnabled.assert_called_once_with(True)
+ self.presenter.on_output_mode_changed()
+ self.presenter._view.can_sas_checkbox.setEnabled.assert_called_once_with(True)
+ self.presenter._view.nx_can_sas_checkbox.setEnabled.assert_called_once_with(True)
+ self.presenter._view.rkh_checkbox.setEnabled.assert_called_once_with(True)
def test_that_rkh_and_nx_can_sas_are_enabled_if_switching_to_non_memory_mode_and_in_2D_reduction_mode(self):
"""This tests that nx_can_sas and rkh file type buttons are enabled if switching to file or both mode, when
reduction dimensionality is 1D, but can sas is not enabled"""
- presenter = RunTabPresenter(SANSFacility.ISIS)
+
view = mock.MagicMock()
view.output_mode_memory_radio_button.isChecked = mock.Mock(return_value=False)
@@ -1214,42 +749,42 @@ class RunTabPresenterTest(unittest.TestCase):
view.nx_can_sas_checkbox.setEnabled = mock.Mock()
view.rkh_checkbox.setEnabled = mock.Mock()
- presenter.set_view(view)
+ self.presenter.set_view(view)
- presenter.on_output_mode_changed()
- presenter._view.can_sas_checkbox.setEnabled.assert_not_called()
- presenter._view.nx_can_sas_checkbox.setEnabled.assert_called_once_with(True)
- presenter._view.rkh_checkbox.setEnabled.assert_called_once_with(True)
+ self.presenter.on_output_mode_changed()
+ self.presenter._view.can_sas_checkbox.setEnabled.assert_not_called()
+ self.presenter._view.nx_can_sas_checkbox.setEnabled.assert_called_once_with(True)
+ self.presenter._view.rkh_checkbox.setEnabled.assert_called_once_with(True)
def test_that_on_reduction_mode_changed_calls_update_hab_if_selection_is_HAB(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter._beam_centre_presenter = mock.MagicMock()
- presenter.on_reduction_mode_selection_has_changed("Hab")
- presenter._beam_centre_presenter.update_hab_selected.assert_called_once_with()
+ self.presenter._beam_centre_presenter = mock.MagicMock()
- presenter._beam_centre_presenter.reset_mock()
- presenter.on_reduction_mode_selection_has_changed("front")
- presenter._beam_centre_presenter.update_hab_selected.assert_called_once_with()
+ self.presenter.on_reduction_mode_selection_has_changed("Hab")
+ self.presenter._beam_centre_presenter.update_hab_selected.assert_called_once_with()
+
+ self.presenter._beam_centre_presenter.reset_mock()
+ self.presenter.on_reduction_mode_selection_has_changed("front")
+ self.presenter._beam_centre_presenter.update_hab_selected.assert_called_once_with()
def test_that_on_reduction_mode_changed_calls_update_lab_if_selection_is_LAB(self):
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter._beam_centre_presenter = mock.MagicMock()
- presenter.on_reduction_mode_selection_has_changed("rear")
- presenter._beam_centre_presenter.update_lab_selected.assert_called_once_with()
+ self.presenter._beam_centre_presenter = mock.MagicMock()
+
+ self.presenter.on_reduction_mode_selection_has_changed("rear")
+ self.presenter._beam_centre_presenter.update_lab_selected.assert_called_once_with()
- presenter._beam_centre_presenter.reset_mock()
- presenter.on_reduction_mode_selection_has_changed("main-detector")
- presenter._beam_centre_presenter.update_lab_selected.assert_called_once_with()
+ self.presenter._beam_centre_presenter.reset_mock()
+ self.presenter.on_reduction_mode_selection_has_changed("main-detector")
+ self.presenter._beam_centre_presenter.update_lab_selected.assert_called_once_with()
- presenter._beam_centre_presenter.reset_mock()
- presenter.on_reduction_mode_selection_has_changed("DetectorBench")
- presenter._beam_centre_presenter.update_lab_selected.assert_called_once_with()
+ self.presenter._beam_centre_presenter.reset_mock()
+ self.presenter.on_reduction_mode_selection_has_changed("DetectorBench")
+ self.presenter._beam_centre_presenter.update_lab_selected.assert_called_once_with()
- presenter._beam_centre_presenter.reset_mock()
- presenter.on_reduction_mode_selection_has_changed("rear-detector")
- presenter._beam_centre_presenter.update_lab_selected.assert_called_once_with()
+ self.presenter._beam_centre_presenter.reset_mock()
+ self.presenter.on_reduction_mode_selection_has_changed("rear-detector")
+ self.presenter._beam_centre_presenter.update_lab_selected.assert_called_once_with()
@staticmethod
def _clear_property_manager_data_service():
@@ -1259,11 +794,11 @@ class RunTabPresenterTest(unittest.TestCase):
def _get_files_and_mock_presenter(self, content, is_multi_period=True, row_user_file_path=""):
if row_user_file_path:
- content[1].update({BatchReductionEntry.USER_FILE : row_user_file_path})
+ content[1].user_file = row_user_file_path
batch_parser = mock.MagicMock()
batch_parser.parse_batch_file = mock.MagicMock(return_value=content)
- self.BatchCsvParserMock.return_value = batch_parser
+ self._mock_csv_parser.return_value = batch_parser
batch_file_path = 'batch_file_path'
user_file_path = create_user_file(sample_user_file)
@@ -1271,9 +806,8 @@ class RunTabPresenterTest(unittest.TestCase):
# We just use the sample_user_file since it exists.
view.get_mask_file = mock.MagicMock(return_value=user_file_path)
view.is_multi_period_view = mock.MagicMock(return_value=is_multi_period)
- presenter = RunTabPresenter(SANSFacility.ISIS)
- presenter.set_view(view)
- return batch_file_path, user_file_path, presenter, view
+ self.presenter.set_view(view)
+ return batch_file_path, user_file_path, view
@staticmethod
def _remove_files(user_file_path=None, batch_file_path=None):
diff --git a/scripts/test/SANS/gui_logic/table_model_test.py b/scripts/test/SANS/gui_logic/table_model_test.py
index 9f0ff43a58e8b18367fa67c83f85a7330f152c5a..c39ef0284aac2f2f73281b97365e95ce45727234 100644
--- a/scripts/test/SANS/gui_logic/table_model_test.py
+++ b/scripts/test/SANS/gui_logic/table_model_test.py
@@ -7,13 +7,11 @@
from __future__ import (absolute_import, division, print_function)
import unittest
-from qtpy.QtCore import QCoreApplication
-from mantid.py3compat import mock
-from mantid.py3compat.mock import patch, ANY
-from sans.common.enums import (RowState, SampleShape)
+from sans.common.enums import RowState
+from sans.gui_logic.models.RowEntries import RowEntries
from sans.gui_logic.models.basic_hint_strategy import BasicHintStrategy
-from sans.gui_logic.models.table_model import (TableModel, TableIndexModel, OptionsColumnModel, options_column_bool)
+from sans.gui_logic.models.table_model import TableModel
class TableModelTest(unittest.TestCase):
@@ -23,226 +21,44 @@ class TableModelTest(unittest.TestCase):
def test_batch_file_can_be_set(self):
self._do_test_file_setting(self._batch_file_wrapper, "batch_file")
- def test_that_raises_if_table_index_does_not_exist(self):
- table_model = TableModel()
- row_entry = [''] * 16
- table_index_model = TableIndexModel(*row_entry)
- table_model.add_table_entry(0, table_index_model)
- self.assertRaises(IndexError, table_model.get_table_entry, 1)
-
def test_that_can_get_table_index_model_for_valid_index(self):
table_model = TableModel()
- row_entry = [''] * 16
- table_index_model = TableIndexModel(*row_entry)
- table_model.add_table_entry(0, table_index_model)
- returned_model = table_model.get_table_entry(0)
- self.assertEqual(returned_model.sample_scatter, '')
+ table_index_model = RowEntries()
+ table_model.replace_table_entry(0, table_index_model)
+ returned_model = table_model.get_row(0)
+ self.assertEqual(table_index_model, returned_model)
def test_that_can_set_the_options_column_model(self):
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "", "", "",
- options_column_string="WavelengthMin=1, WavelengthMax=3, NotRegister2=1")
- options_column_model = table_index_model.options_column_model
- options = options_column_model.get_options()
- self.assertEqual(len(options), 2)
- self.assertEqual(options["WavelengthMin"], 1.)
- self.assertEqual(options["WavelengthMax"], 3.)
-
- def test_that_raises_for_missing_equal(self):
- args = [0, "", "", "", "", "", "", "", "", "", "", "", "", "", ""]
- kwargs = {'options_column_string': "WavelengthMin=1, WavelengthMax=3, NotRegister2"}
- self.assertRaises(ValueError, TableIndexModel, *args, **kwargs)
-
- def test_that_sample_shape_can_be_parsed(self):
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "", "", "",
- sample_shape=" flatPlate ")
- sample_shape_enum = table_index_model.sample_shape
- sample_shape_text = table_index_model.sample_shape_string
-
- self.assertEqual(sample_shape_enum, SampleShape.FLAT_PLATE)
- self.assertEqual(sample_shape_text, "FlatPlate")
-
- def test_that_sample_shape_can_be_set_as_enum(self):
- # If a batch file contains a sample shape, it is a enum: SampleShape.Disc, Cylinder, FlatPlate
- # So SampleShapeColumnModel must be able to parse this.
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "", "", "",
- sample_shape=SampleShape.FLAT_PLATE)
- sample_shape_enum = table_index_model.sample_shape
- sample_shape_text = table_index_model.sample_shape_string
-
- self.assertEqual(sample_shape_enum, SampleShape.FLAT_PLATE)
- self.assertEqual(sample_shape_text, "FlatPlate")
-
- def test_that_incorrect_sample_shape_turns_to_not_set(self):
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "", "", "",
- sample_shape="Disc")
- table_index_model.sample_shape = "not a sample shape"
- self.assertEqual("", table_index_model.sample_shape_string)
-
- def test_that_empty_string_turns_to_not_set(self):
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "", "", "",
- sample_shape="Disc")
- table_index_model.sample_shape = ""
-
- sample_shape_enum = table_index_model.sample_shape
- sample_shape_text = table_index_model.sample_shape_string
-
- self.assertEqual(SampleShape.NOT_SET, sample_shape_enum)
- self.assertEqual('', sample_shape_text)
-
- def test_that_table_model_completes_partial_sample_shape(self):
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "", "", "",
- sample_shape="cylind")
-
- sample_shape_enum = table_index_model.sample_shape
- sample_shape_text = table_index_model.sample_shape_string
-
- self.assertEqual(sample_shape_enum, SampleShape.CYLINDER)
- self.assertEqual(sample_shape_text, "Cylinder")
-
- def test_that_querying_nonexistent_row_index_raises_IndexError_exception(self):
- table_model = TableModel()
- args = [0]
- self.assertRaises(IndexError, table_model.get_row_user_file, *args)
-
- def test_that_can_retrieve_user_file_from_table_index_model(self):
- table_model = TableModel()
- table_index_model = TableIndexModel('2', "", "", "", "", "", "",
- "", "", "", "", "", "", "User_file_name")
- table_model.add_table_entry(2, table_index_model)
- user_file = table_model.get_row_user_file(0)
- self.assertEqual(user_file, "User_file_name")
-
- def test_that_can_retrieve_sample_thickness_from_table_index_model(self):
- sample_thickness = '8.0'
- table_model = TableModel()
- table_index_model = TableIndexModel("", "", "", "", "", "",
- "", "", "", "", "", "", sample_thickness=sample_thickness)
- table_model.add_table_entry(2, table_index_model)
- table_model.get_thickness_for_rows()
- row_entry = table_model.get_table_entry(0)
- self.assertEqual(row_entry.sample_thickness, sample_thickness)
-
- @patch("sans.common.file_information.SANSFileInformation", autospec=True)
- @patch("sans.common.file_information.SANSFileInformationFactory", autospec=True)
- def test_that_sample_dimensions_are_respected(self, file_info_factory_mock, file_info_mock):
- # Check that if the user enters their own sample dimensions we do not override them
- file_info_mock.get_shape.return_value = ""
-
- file_dimensions = 1.0
- file_info_mock.get_height.return_value = file_dimensions
- file_info_mock.get_thickness.return_value = file_dimensions
- file_info_mock.get_width.return_value = file_dimensions
-
- file_info_factory_mock.create_sans_file_information.return_value = file_info_mock
-
- expected_dims = ['12.0', '13.0', '14.0']
-
- table_model = TableModel(file_information_factory=file_info_factory_mock)
- table_index_model = TableIndexModel("1", "", "", "", "", "",
- "", "", "", "", "", "",
- sample_thickness=expected_dims[0],
- sample_height=expected_dims[1],
- sample_width=expected_dims[2])
- table_model.add_table_entry(row=1, table_index_model=table_index_model)
- table_model.get_thickness_for_rows()
-
- row_entry = table_model.get_table_entry(0)
- file_info_factory_mock.create_sans_file_information.assert_any_call(ANY)
- self.assertEqual(float(expected_dims[0]), row_entry.sample_thickness)
- self.assertEqual(float(expected_dims[1]), row_entry.sample_height)
- self.assertEqual(float(expected_dims[2]), row_entry.sample_width)
-
- @patch("sans.common.file_information.SANSFileInformation", autospec=True)
- @patch("sans.common.file_information.SANSFileInformationFactory", autospec=True)
- def test_sample_dimensions_loaded_if_not_specified(self, file_info_factory_mock, file_info_mock):
- file_info_mock.get_shape.return_value = ""
-
- file_dimensions = 12.0
- file_info_mock.get_height.return_value = file_dimensions
- file_info_mock.get_thickness.return_value = file_dimensions
- file_info_mock.get_width.return_value = file_dimensions
-
- file_info_factory_mock.create_sans_file_information.return_value = file_info_mock
-
- blank_dim = " " # have a space to check whitespace isn't considered as a length
-
- table_model = TableModel(file_information_factory=file_info_factory_mock)
- table_index_model = TableIndexModel("1", "", "", "", "", "",
- "", "", "", "", "", "",
- sample_thickness=blank_dim,
- sample_height=blank_dim,
- sample_width=blank_dim)
- table_model.add_table_entry(row=1, table_index_model=table_index_model)
- table_model.get_thickness_for_rows()
-
- row_entry = table_model.get_table_entry(0)
- file_info_factory_mock.create_sans_file_information.assert_any_call(ANY)
- self.assertEqual(file_dimensions, row_entry.sample_thickness)
- self.assertEqual(file_dimensions, row_entry.sample_height)
- self.assertEqual(file_dimensions, row_entry.sample_width)
-
- @patch("sans.common.file_information.SANSFileInformation", autospec=True)
- def test_bad_user_length_is_handled(self, file_info_mock):
- file_dimensions = 12.0
- file_info_mock.get_shape.return_value = ""
- file_info_mock.get_height.return_value = file_dimensions
- file_info_mock.get_thickness.return_value = file_dimensions
- file_info_mock.get_width.return_value = file_dimensions
-
- table_model = TableModel()
- table_index_model = TableIndexModel("1", "", "", "", "", "",
- "", "", "", "", "", "",
- sample_thickness="a",
- sample_height="b",
- sample_width="c")
- table_model.add_table_entry(0, table_index_model=table_index_model)
-
- logger_mock = mock.Mock()
- table_model.logger = logger_mock
-
- table_model.update_thickness_from_file_information(id=0, file_information=file_info_mock)
-
- logger_mock.warning.assert_any_call(ANY)
- self.assertEqual(3, logger_mock.warning.call_count) # One warning for each sample dim
+ table_index_model = RowEntries()
+ table_index_model.options.set_user_options("WavelengthMin=1, WavelengthMax=3, NotRegister2=1")
- def test_convert_to_float(self):
- table_model = TableModel()
-
- from_valid_string = table_model.convert_to_float_or_return_none("3.0")
- self.assertEqual(3.0, from_valid_string)
-
- def test_convert_to_float_from_existing_float(self):
- table_model = TableModel()
- from_existing_float = table_model.convert_to_float_or_return_none(4.0)
- self.assertEqual(4.0, from_existing_float)
+ options_dict = table_index_model.options.get_options_dict()
+ self.assertEqual(len(options_dict), 2)
+ self.assertEqual(options_dict["WavelengthMin"], 1.)
+ self.assertEqual(options_dict["WavelengthMax"], 3.)
- def test_convert_to_float_from_bad_input(self):
- table_model = TableModel()
- from_bad_input = table_model.convert_to_float_or_return_none("")
- self.assertEqual(None, from_bad_input)
+ def test_that_raises_for_missing_equal(self):
+ row = RowEntries()
+ row.options.set_user_options("WavelengthMin=1, WavelengthMax=3, NotRegister2")
+ with self.assertRaises(ValueError):
+ row.options.get_options_dict()
def test_that_parse_string_returns_correctly(self):
string_to_parse = 'EventSlices=1-6,5-9,4:5:89 , WavelengthMax=78 , WavelengthMin=9'
- expected_dict = {'EventSlices': '1-6,5-9,4:5:89', 'WavelengthMax': '78', 'WavelengthMin': '9'}
+ entry = RowEntries()
+ entry.options.set_user_options(string_to_parse)
+ expected_dict = {'EventSlices': '1-6,5-9,4:5:89', 'WavelengthMax': 78.0, 'WavelengthMin': 9.0}
- parsed_dict = OptionsColumnModel._parse_string(string_to_parse)
+ parsed_dict = entry.options.get_options_dict()
- self.assertEqual(parsed_dict, expected_dict)
+ self.assertEqual(expected_dict, parsed_dict)
def test_get_number_of_rows_returns_number_of_entries(self):
table_model = TableModel()
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(0, table_index_model)
- table_index_model = TableIndexModel('1', "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(1, table_index_model)
+ table_index_model = RowEntries()
+ table_model.replace_table_entry(0, table_index_model)
+ table_index_model = RowEntries()
+ table_model.replace_table_entry(1, table_index_model)
number_of_rows = table_model.get_number_of_rows()
@@ -250,45 +66,30 @@ class TableModelTest(unittest.TestCase):
def test_when_table_is_cleared_is_left_with_one_empty_row(self):
table_model = TableModel()
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(0, table_index_model)
- table_index_model = TableIndexModel('1', "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(1, table_index_model)
- empty_row = table_model.create_empty_row()
- empty_row.id = 2
+ table_model.append_table_entry(RowEntries())
+ table_model.append_table_entry(RowEntries())
+
+ self.assertEqual(2, table_model.get_number_of_rows())
table_model.clear_table_entries()
- self.assertEqual(table_model.get_number_of_rows(), 1)
- self.assertEqual(table_model.get_table_entry(0), empty_row)
+ self.assertEqual(table_model.get_number_of_rows(), 0)
+ self.assertTrue(table_model.get_row(0).is_empty())
def test_when_last_row_is_removed_table_is_left_with_one_empty_row(self):
table_model = TableModel()
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(0, table_index_model)
- table_index_model = TableIndexModel('1', "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(1, table_index_model)
- empty_row = table_model.create_empty_row()
- empty_row.id = 2
-
- table_model.remove_table_entries([0, 1])
+ table_model.append_table_entry(RowEntries())
+ table_model.append_table_entry(RowEntries())
- self.assertEqual(table_model.get_number_of_rows(), 1)
- self.assertEqual(table_model.get_table_entry(0), empty_row)
+ self.assertEqual(2, table_model.get_number_of_rows())
- def test_that_OptionsColumnModel_get_permissable_properties_returns_correct_properties(self):
- permissable_properties = OptionsColumnModel._get_permissible_properties()
+ table_model.remove_table_entries([0, 1])
- self.assertEqual(permissable_properties, {"WavelengthMin": float, "WavelengthMax": float, "EventSlices": str,
- "MergeScale": float, "MergeShift": float, "PhiMin": float,
- "PhiMax": float, "UseMirror": options_column_bool})
+ self.assertEqual(table_model.get_number_of_rows(), 0)
+ self.assertTrue(table_model.get_row(0).is_empty())
def test_that_OptionsColumnModel_get_hint_strategy(self):
- hint_strategy = OptionsColumnModel.get_hint_strategy()
+ hint_strategy = TableModel.get_options_hint_strategy()
expected_hint_strategy = BasicHintStrategy({
"WavelengthMin": 'The min value of the wavelength when converting from TOF.',
"WavelengthMax": 'The max value of the wavelength when converting from TOF.',
@@ -307,134 +108,78 @@ class TableModelTest(unittest.TestCase):
self.assertEqual(expected_hint_strategy, hint_strategy)
- def test_that_row_state_is_initially_unprocessed(self):
- table_index_model = TableIndexModel(0, "", "", "", "", "", "",
- "", "", "", "", "", "")
-
- self.assertEqual(table_index_model.row_state, RowState.UNPROCESSED)
- self.assertEqual(table_index_model.tool_tip, '')
-
- def test_that_set_processed_sets_state_to_processed(self):
+ def test_that_set_row_to_error_sets_row_to_error_and_tool_tip(self):
table_model = TableModel()
- table_index_model = TableIndexModel(0, "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(0, table_index_model)
- row = 0
- tool_tip = 'Processesing succesful'
+ table_index_model = RowEntries()
- table_model.set_row_to_processed(row, tool_tip)
+ table_model.replace_table_entry(0, table_index_model)
- self.assertEqual(table_index_model.row_state, RowState.PROCESSED)
- self.assertEqual(table_index_model.tool_tip, tool_tip)
-
- def test_that_reset_row_state_sets_row_to_unproceesed_and_sets_tool_tip_to_empty(self):
- table_model = TableModel()
- table_index_model = TableIndexModel(0, "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(0, table_index_model)
- row = 0
- tool_tip = 'Processesing succesful'
- table_model.set_row_to_processed(row, tool_tip)
-
- table_model.reset_row_state(row)
-
- self.assertEqual(table_index_model.row_state, RowState.UNPROCESSED)
- self.assertEqual(table_index_model.tool_tip, '')
-
- def test_that_set_row_to_error_sets_row_to_error_and_tool_tip(self):
- table_model = TableModel()
- table_index_model = TableIndexModel(0, "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(0, table_index_model)
row = 0
tool_tip = 'There was an error'
table_model.set_row_to_error(row, tool_tip)
+ row_entry = table_model.get_row(0)
- self.assertEqual(table_index_model.row_state, RowState.ERROR)
- self.assertEqual(table_index_model.tool_tip, tool_tip)
-
- def test_serialise_options_dict_correctly(self):
- options_column_model = OptionsColumnModel('EventSlices=1-6,5-9,4:5:89 , WavelengthMax=78 , WavelengthMin=9')
- options_column_model.set_option('MergeScale', 1.5)
-
- options_string = options_column_model.get_options_string()
-
- self.assertEqual(options_string, 'EventSlices=1-6,5-9,4:5:89, MergeScale=1.5,'
- ' WavelengthMax=78.0, WavelengthMin=9.0')
+ self.assertTrue(RowState.ERROR, row_entry.state)
+ self.assertEqual(tool_tip, row_entry.tool_tip)
- def test_that_truthy_options_are_evaluated_True(self):
- options_column_model = OptionsColumnModel('UseMirror=True')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': True})
+ def test_that_get_non_empty_rows_returns_non_empty_rows(self):
+ table_model = TableModel()
+ empty_row = RowEntries()
- options_column_model = OptionsColumnModel('UseMirror=1')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': True})
+ table_model.append_table_entry(empty_row)
+ table_model.append_table_entry(RowEntries(sample_scatter=123))
+ table_model.append_table_entry(empty_row)
+ table_model.append_table_entry(RowEntries(sample_direct=345))
+ table_model.append_table_entry(empty_row)
- options_column_model = OptionsColumnModel('UseMirror=Yes')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': True})
+ self.assertEqual(2, len(table_model.get_non_empty_rows()))
- options_column_model = OptionsColumnModel('UseMirror=T')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': True})
+ for i in table_model.get_non_empty_rows():
+ self.assertFalse(i.is_empty())
- options_column_model = OptionsColumnModel('UseMirror=Y')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': True})
+ self.assertEqual(5, table_model.get_number_of_rows())
- options_column_model = OptionsColumnModel('UseMirror=tRuE')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': True})
+ def test_default_obj_correctly_tracked(self):
+ # We need to make sure there is always 1 object in table model, but not to get it mixed with user input
+ obj = TableModel()
+ self.assertEqual(0, obj.get_number_of_rows())
- def test_that_falsy_options_are_evaluated_False(self):
- options_column_model = OptionsColumnModel('UseMirror=False')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': False})
+ obj.clear_table_entries()
+ self.assertEqual(0, obj.get_number_of_rows())
- options_column_model = OptionsColumnModel('UseMirror=0')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': False})
+ obj.append_table_entry(RowEntries())
+ self.assertEqual(1, obj.get_number_of_rows())
+ obj.append_table_entry(RowEntries())
+ self.assertEqual(2, obj.get_number_of_rows())
- options_column_model = OptionsColumnModel('UseMirror=No')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': False})
+ obj.clear_table_entries()
+ self.assertEqual(0, obj.get_number_of_rows())
+ obj.append_table_entry(RowEntries())
+ self.assertEqual(1, obj.get_number_of_rows())
- options_column_model = OptionsColumnModel('UseMirror=F')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': False})
+ def test_get_num_rows(self):
+ obj = TableModel()
+ self.assertEqual(0, obj.get_number_of_rows())
- options_column_model = OptionsColumnModel('UseMirror=N')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': False})
+ obj.append_table_entry(RowEntries())
+ self.assertEqual(1, obj.get_number_of_rows())
- options_column_model = OptionsColumnModel('UseMirror=fAlSE')
- self.assertEqual(options_column_model.get_options(), {'UseMirror': False})
+ obj.remove_table_entries([0])
+ self.assertEqual(0, obj.get_number_of_rows())
- def test_that_non_bool_option_raises_error_if_option_is_bool(self):
- with self.assertRaises(ValueError):
- OptionsColumnModel("UseMirror=SomeString")
+ def test_inserting_row_at_pos(self):
+ model = TableModel()
- def test_that_to_batch_list_is_correct_format(self):
- test_row = ['SANS2D00022024 ', '', 'SANS2D00022025 ', '', ' SANS2D00022026 ', '', '', '', '', '', '', '',
- ' out_file', 'a_user_file ', 1.0, 5.0, 5.4, 'Disc', 'WavelengthMax=5.0']
- table_index_model = TableIndexModel(*test_row)
+ expected_order = [RowEntries() for _ in range(3)]
+ model.replace_table_entry(row_index=0, row_entry=expected_order[0])
+ model.replace_table_entry(row_index=1, row_entry=expected_order[2])
- actual_list = table_index_model.to_batch_list()
- expected_list = ["SANS2D00022024", "SANS2D00022025", "SANS2D00022026",
- "", "", "", "out_file", "a_user_file", "1.0", "5.0", "5.4"]
+ self.assertTrue(2, model.get_number_of_rows())
- self.assertEqual(actual_list, expected_list)
-
- def test_that_get_non_empty_rows_returns_non_empty_rows(self):
- table_model = TableModel()
- table_index_model = TableIndexModel("", "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(0, table_index_model)
- table_index_model = TableIndexModel('0', "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(1, table_index_model)
- table_index_model = TableIndexModel('', "", "", "", "", "", "",
- "", "", "", "5", "", "")
- table_model.add_table_entry(2, table_index_model)
- table_index_model = TableIndexModel("", "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(3, table_index_model)
-
- non_empty_rows_actual = table_model.get_non_empty_rows([0, 1, 2, 3])
- non_empty_rows_expected = [1, 2]
-
- self.assertEqual(non_empty_rows_actual, non_empty_rows_expected)
+ model.insert_row_at(1, expected_order[1])
+ self.assertTrue(3, model.get_number_of_rows())
+ self.assertEqual(expected_order, model.get_all_rows())
def _do_test_file_setting(self, func, prop):
# Test that can set to empty string
@@ -460,24 +205,5 @@ class TableModelTest(unittest.TestCase):
table_model = TableModel()
table_model.user_file = value
-
-class TableModelThreadingTest(unittest.TestCase):
- @classmethod
- def setUpClass(cls):
- cls.qApp = QCoreApplication(['test_app'])
-
- def test_that_get_thickness_for_rows_updates_table_correctly(self):
- table_model = TableModel()
- table_index_model = TableIndexModel("LOQ74044", "", "", "", "", "", "",
- "", "", "", "", "", "")
- table_model.add_table_entry(0, table_index_model)
-
- table_model.get_thickness_for_rows()
- table_model.work_handler.wait_for_done()
- self.qApp.processEvents()
-
- self.assertEqual(table_index_model.sample_thickness, 1.0)
-
-
if __name__ == '__main__':
unittest.main()
diff --git a/scripts/test/SANS/state/CMakeLists.txt b/scripts/test/SANS/state/CMakeLists.txt
index 37989207431f5a9ca7a84871831a156c422625ab..bcaf1226196bd68f6d1f6f394ca03e7203296e37 100644
--- a/scripts/test/SANS/state/CMakeLists.txt
+++ b/scripts/test/SANS/state/CMakeLists.txt
@@ -15,6 +15,7 @@ set(TEST_PY_FILES
slice_event_test.py
save_test.py
state_test.py
+ StateRunDataBuilderTest.py
wavelength_test.py
wavelength_and_pixel_adjustment_test.py)
diff --git a/scripts/test/SANS/state/StateBuilderTest.py b/scripts/test/SANS/state/StateBuilderTest.py
new file mode 100644
index 0000000000000000000000000000000000000000..c67404d9a66e0292c4bd3b6b779f2a1d18767393
--- /dev/null
+++ b/scripts/test/SANS/state/StateBuilderTest.py
@@ -0,0 +1,65 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+import unittest
+
+from mantid.py3compat import mock
+
+from sans.state.IStateParser import IStateParser
+from sans.state.StateRunDataBuilder import StateRunDataBuilder
+from sans.state.StateBuilder import StateBuilder
+
+
+class StateBuilderTest(unittest.TestCase):
+ def setUp(self):
+ self.file_parser = mock.create_autospec(spec=IStateParser)
+ self.data_parser = mock.create_autospec(spec=StateRunDataBuilder)
+ self.instance = StateBuilder(run_data_builder=self.data_parser, i_state_parser=self.file_parser)
+
+ def test_builder_forwards_from_user_file_parser(self):
+ # These should be without modification
+ unmodified_methods = {"get_all_states",
+ "get_state_adjustment",
+ "get_state_calculate_transmission",
+ "get_state_compatibility",
+ "get_state_convert_to_q",
+ "get_state_data",
+ "get_state_mask_detectors",
+ "get_state_move_detectors",
+ "get_state_normalize_to_monitor",
+ "get_state_reduction_mode",
+ "get_state_save",
+ "get_state_scale",
+ "get_state_slice_event",
+ "get_state_wavelength",
+ "get_state_wavelength_and_pixel_adjustment"}
+
+ for method_name in unmodified_methods:
+ expected_obj = mock.Mock()
+ getattr(self.file_parser, method_name).return_value = expected_obj
+ # This should forward on without change
+ returned_obj = getattr(self.instance, method_name)()
+
+ getattr(self.file_parser, method_name).assert_called_once()
+ self.assertEqual(returned_obj, expected_obj)
+
+ def test_builder_injects_modifications(self):
+ modified_methods = {"get_all_states" : "pack_all_states",
+ "get_state_scale": "pack_state_scale"}
+
+ for method_name, data_packing_method in modified_methods.items():
+ injected_obj = mock.Mock() # This should be forwarded to the data builder
+ getattr(self.file_parser, method_name).return_value = injected_obj
+
+ # This should forward on to the data_builder instance
+ getattr(self.instance, method_name)()
+
+ getattr(self.file_parser, method_name).assert_called_once()
+ getattr(self.data_parser, data_packing_method).assert_called_with(injected_obj)
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/scripts/test/SANS/state/StateRunDataBuilderTest.py b/scripts/test/SANS/state/StateRunDataBuilderTest.py
new file mode 100644
index 0000000000000000000000000000000000000000..9a7450b7e2329c40989130c837d32012ef67379d
--- /dev/null
+++ b/scripts/test/SANS/state/StateRunDataBuilderTest.py
@@ -0,0 +1,30 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +
+import unittest
+
+from mantid.py3compat import mock
+
+from sans.state.StateRunDataBuilder import StateRunDataBuilder
+from sans.state.StateObjects.StateScale import StateScale
+
+
+class StateRunDataBuilderTest(unittest.TestCase):
+ def setUp(self):
+ self.mock_file_information = mock.Mock()
+ self.instance = StateRunDataBuilder(file_information=self.mock_file_information)
+
+ def test_pack_all_calls_all_other_methods(self):
+ mocked_all_states = mock.Mock()
+ mock_state = mock.Mock(spec=StateScale)
+ mocked_all_states.scale = mock_state
+
+ self.instance.pack_all_states(all_states=mocked_all_states)
+ self.assertTrue(mock_state.set_geometry_from_file.called)
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/scripts/test/SANS/state/adjustment_test.py b/scripts/test/SANS/state/adjustment_test.py
index 2423f9a4e18b6fdcf11568c2d28d71ee5c9a8d48..1c31dc5774e476920f318eb96deb3a3fb3afca0e 100644
--- a/scripts/test/SANS/state/adjustment_test.py
+++ b/scripts/test/SANS/state/adjustment_test.py
@@ -9,11 +9,11 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (SANSFacility, SANSInstrument)
-from sans.state.adjustment import (StateAdjustment, get_adjustment_builder)
-from sans.state.calculate_transmission import StateCalculateTransmission
-from sans.state.data import (get_data_builder)
-from sans.state.normalize_to_monitor import StateNormalizeToMonitor
-from sans.state.wavelength_and_pixel_adjustment import StateWavelengthAndPixelAdjustment
+from sans.state.StateObjects.StateAdjustment import (StateAdjustment, get_adjustment_builder)
+from sans.state.StateObjects.StateCalculateTransmission import StateCalculateTransmission
+from sans.state.StateObjects.StateData import (get_data_builder)
+from sans.state.StateObjects.StateNormalizeToMonitor import StateNormalizeToMonitor
+from sans.state.StateObjects.StateWavelengthAndPixelAdjustment import StateWavelengthAndPixelAdjustment
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/calculate_transmission_test.py b/scripts/test/SANS/state/calculate_transmission_test.py
index cf75cbe5ab0ca22e10baa5b749fd14d559a5501c..c907fedd890e43f6316e8e5c960e37ea3a0c60ca 100644
--- a/scripts/test/SANS/state/calculate_transmission_test.py
+++ b/scripts/test/SANS/state/calculate_transmission_test.py
@@ -9,9 +9,9 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (RebinType, RangeStepType, FitType, DataType, SANSFacility, SANSInstrument)
-from sans.state.calculate_transmission import (StateCalculateTransmission, StateCalculateTransmissionLOQ,
- get_calculate_transmission_builder)
-from sans.state.data import get_data_builder
+from sans.state.StateObjects.StateCalculateTransmission import (StateCalculateTransmission, StateCalculateTransmissionLOQ,
+ get_calculate_transmission_builder)
+from sans.state.StateObjects.StateData import get_data_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/convert_to_q_test.py b/scripts/test/SANS/state/convert_to_q_test.py
index 6b5d744849bfcef002c50b55462fc09f9c255a48..680791b0c08dd9a7a10bb93d1f0c99684c2804ef 100644
--- a/scripts/test/SANS/state/convert_to_q_test.py
+++ b/scripts/test/SANS/state/convert_to_q_test.py
@@ -9,8 +9,8 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (RangeStepType, ReductionDimensionality, SANSFacility, SANSInstrument)
-from sans.state.convert_to_q import (StateConvertToQ, get_convert_to_q_builder)
-from sans.state.data import get_data_builder
+from sans.state.StateObjects.StateConvertToQ import (StateConvertToQ, get_convert_to_q_builder)
+from sans.state.StateObjects.StateData import get_data_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/data_test.py b/scripts/test/SANS/state/data_test.py
index 449583d626365c6388be38f195afd7ccb75b84f1..30bd6c93f5e3b4a9f22b1654a743b001e1f4bec1 100644
--- a/scripts/test/SANS/state/data_test.py
+++ b/scripts/test/SANS/state/data_test.py
@@ -9,7 +9,7 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (SANSFacility, SANSInstrument)
-from sans.state.data import (StateData, get_data_builder)
+from sans.state.StateObjects.StateData import (StateData, get_data_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/mask_test.py b/scripts/test/SANS/state/mask_test.py
index 5df51fec9bbc58bb1d36919cf3f1f7507b148597..25f70abfd5b5910af37914ee84761df9dbc54b4d 100644
--- a/scripts/test/SANS/state/mask_test.py
+++ b/scripts/test/SANS/state/mask_test.py
@@ -9,8 +9,8 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (SANSFacility, DetectorType)
-from sans.state.data import get_data_builder
-from sans.state.mask import (StateMaskSANS2D, get_mask_builder)
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateMaskDetectors import (StateMaskSANS2D, get_mask_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
# ----------------------------------------------------------------------------------------------------------------------
diff --git a/scripts/test/SANS/state/move_test.py b/scripts/test/SANS/state/move_test.py
index 1b8e05176ed744a808197f91df11e45bc5321590..3e194bb9f81285539a72f9a5fbd2e556efb1b3a2 100644
--- a/scripts/test/SANS/state/move_test.py
+++ b/scripts/test/SANS/state/move_test.py
@@ -9,9 +9,9 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (CanonicalCoordinates, SANSFacility, DetectorType, SANSInstrument)
-from sans.state.data import get_data_builder
-from sans.state.move import (StateMoveLOQ, StateMoveSANS2D, StateMoveLARMOR, StateMoveZOOM, StateMove,
- StateMoveDetector, get_move_builder)
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateMoveDetectors import (StateMoveLOQ, StateMoveSANS2D, StateMoveLARMOR, StateMoveZOOM, StateMove,
+ StateMoveDetectors, get_move_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
@@ -21,8 +21,8 @@ from sans.test_helper.file_information_mock import SANSFileInformationMock
class StateMoveWorkspaceTest(unittest.TestCase):
def test_that_raises_if_the_detector_name_is_not_set_up(self):
state = StateMove()
- state.detectors = {DetectorType.LAB.value: StateMoveDetector(),
- DetectorType.HAB.value: StateMoveDetector()}
+ state.detectors = {DetectorType.LAB.value: StateMoveDetectors(),
+ DetectorType.HAB.value: StateMoveDetectors()}
state.detectors[DetectorType.LAB.value].detector_name = "test"
state.detectors[DetectorType.HAB.value].detector_name_short = "test"
state.detectors[DetectorType.LAB.value].detector_name_short = "test"
@@ -34,8 +34,8 @@ class StateMoveWorkspaceTest(unittest.TestCase):
def test_that_raises_if_the_short_detector_name_is_not_set_up(self):
state = StateMove()
- state.detectors = {DetectorType.LAB.value: StateMoveDetector(),
- DetectorType.HAB.value: StateMoveDetector()}
+ state.detectors = {DetectorType.LAB.value: StateMoveDetectors(),
+ DetectorType.HAB.value: StateMoveDetectors()}
state.detectors[DetectorType.HAB.value].detector_name = "test"
state.detectors[DetectorType.LAB.value].detector_name = "test"
state.detectors[DetectorType.HAB.value].detector_name_short = "test"
@@ -47,8 +47,8 @@ class StateMoveWorkspaceTest(unittest.TestCase):
def test_that_general_isis_default_values_are_set_up(self):
state = StateMove()
- state.detectors = {DetectorType.LAB.value: StateMoveDetector(),
- DetectorType.HAB.value: StateMoveDetector()}
+ state.detectors = {DetectorType.LAB.value: StateMoveDetectors(),
+ DetectorType.HAB.value: StateMoveDetectors()}
self.assertEqual(state.sample_offset, 0.0)
self.assertEqual(state.sample_offset_direction, CanonicalCoordinates.Z)
self.assertEqual(state.detectors[DetectorType.HAB.value].x_translation_correction, 0.0)
diff --git a/scripts/test/SANS/state/normalize_to_monitor_test.py b/scripts/test/SANS/state/normalize_to_monitor_test.py
index cf2fb86e9b09f1fd6b2688e23993ad757b540e26..950bfbf3e0026679196124b3df995c55d9d6b899 100644
--- a/scripts/test/SANS/state/normalize_to_monitor_test.py
+++ b/scripts/test/SANS/state/normalize_to_monitor_test.py
@@ -9,9 +9,9 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (RebinType, RangeStepType, SANSFacility, SANSInstrument)
-from sans.state.data import get_data_builder
-from sans.state.normalize_to_monitor import (StateNormalizeToMonitor, StateNormalizeToMonitorLOQ,
- get_normalize_to_monitor_builder)
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateNormalizeToMonitor import (StateNormalizeToMonitor, StateNormalizeToMonitorLOQ,
+ get_normalize_to_monitor_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/reduction_mode_test.py b/scripts/test/SANS/state/reduction_mode_test.py
index 53e2e2fdadb6ddc108845036ffb494237eebea42..d8b62f98c89e5021720590b265066d0ddb115e08 100644
--- a/scripts/test/SANS/state/reduction_mode_test.py
+++ b/scripts/test/SANS/state/reduction_mode_test.py
@@ -10,8 +10,8 @@ import unittest
from sans.common.enums import (ReductionMode, ReductionDimensionality, FitModeForMerge,
SANSFacility, SANSInstrument, DetectorType)
-from sans.state.data import get_data_builder
-from sans.state.reduction_mode import (StateReductionMode, get_reduction_mode_builder)
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateReductionMode import (StateReductionMode, get_reduction_mode_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/save_test.py b/scripts/test/SANS/state/save_test.py
index d2d5c639daa6dfd77c0b3c1388a322ed45fb85f7..a7b4664c93806a064e89ae718fdb86ffc7fa1250 100644
--- a/scripts/test/SANS/state/save_test.py
+++ b/scripts/test/SANS/state/save_test.py
@@ -9,8 +9,8 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (SANSFacility, SaveType, SANSInstrument)
-from sans.state.data import (get_data_builder)
-from sans.state.save import (get_save_builder)
+from sans.state.StateObjects.StateData import (get_data_builder)
+from sans.state.StateObjects.StateSave import (get_save_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/scale_test.py b/scripts/test/SANS/state/scale_test.py
index f27e9ac55ea89257dd8a8dbc969df15ccc18eae3..44747495cb8c9f7dce6df27253a7b60812c40d0d 100644
--- a/scripts/test/SANS/state/scale_test.py
+++ b/scripts/test/SANS/state/scale_test.py
@@ -9,8 +9,8 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (SANSFacility, SampleShape)
-from sans.state.data import get_data_builder
-from sans.state.scale import get_scale_builder
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateScale import get_scale_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/slice_event_test.py b/scripts/test/SANS/state/slice_event_test.py
index d6ba7e7e3deb3b3c80b1ab751f5ffeb05dcdf876..6b4df8b71d9ea80db2e23d21c475228eaf26443b 100644
--- a/scripts/test/SANS/state/slice_event_test.py
+++ b/scripts/test/SANS/state/slice_event_test.py
@@ -9,8 +9,8 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (SANSFacility, SANSInstrument)
-from sans.state.data import get_data_builder
-from sans.state.slice_event import (StateSliceEvent, get_slice_event_builder)
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateSliceEvent import (StateSliceEvent, get_slice_event_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/state_functions_test.py b/scripts/test/SANS/state/state_functions_test.py
index 68cf0deeb5c6624ff5d7c117ddc5b81acc1053e8..e63e69ac333ddace960bb0a8023a566469fa4b24 100644
--- a/scripts/test/SANS/state/state_functions_test.py
+++ b/scripts/test/SANS/state/state_functions_test.py
@@ -9,7 +9,7 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (ReductionDimensionality)
-from sans.state.data import StateData
+from sans.state.StateObjects.StateData import StateData
from sans.state.state_functions import (is_pure_none_or_not_none, one_is_none,
validation_message, is_not_none_and_first_larger_than_second)
from sans.test_helper.test_director import TestDirector
diff --git a/scripts/test/SANS/state/state_test.py b/scripts/test/SANS/state/state_test.py
index 42104221171a24658ee921281745204ff79f31e9..97dc12517ba476fd120695100da092957dfa302f 100644
--- a/scripts/test/SANS/state/state_test.py
+++ b/scripts/test/SANS/state/state_test.py
@@ -9,20 +9,20 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (SANSInstrument, SANSFacility)
-from sans.state.adjustment import (StateAdjustment)
-from sans.state.calculate_transmission import (StateCalculateTransmission)
-from sans.state.convert_to_q import (StateConvertToQ)
-from sans.state.data import (StateData)
-from sans.state.mask import (StateMask)
-from sans.state.move import (StateMove)
-from sans.state.normalize_to_monitor import (StateNormalizeToMonitor)
-from sans.state.reduction_mode import (StateReductionMode)
-from sans.state.save import (StateSave)
-from sans.state.scale import (StateScale)
-from sans.state.slice_event import (StateSliceEvent)
-from sans.state.state import (State)
-from sans.state.wavelength import (StateWavelength)
-from sans.state.wavelength_and_pixel_adjustment import (StateWavelengthAndPixelAdjustment)
+from sans.state.StateObjects.StateAdjustment import (StateAdjustment)
+from sans.state.StateObjects.StateCalculateTransmission import (StateCalculateTransmission)
+from sans.state.StateObjects.StateConvertToQ import (StateConvertToQ)
+from sans.state.StateObjects.StateData import (StateData)
+from sans.state.StateObjects.StateMaskDetectors import (StateMask)
+from sans.state.StateObjects.StateMoveDetectors import (StateMove)
+from sans.state.StateObjects.StateNormalizeToMonitor import (StateNormalizeToMonitor)
+from sans.state.StateObjects.StateReductionMode import (StateReductionMode)
+from sans.state.StateObjects.StateSave import (StateSave)
+from sans.state.StateObjects.StateScale import (StateScale)
+from sans.state.StateObjects.StateSliceEvent import (StateSliceEvent)
+from sans.state.AllStates import (AllStates)
+from sans.state.StateObjects.StateWavelength import (StateWavelength)
+from sans.state.StateObjects.StateWavelengthAndPixelAdjustment import (StateWavelengthAndPixelAdjustment)
# ----------------------------------------------------------------------------------------------------------------------
@@ -105,7 +105,7 @@ class MockStateConvertToQ(StateConvertToQ):
class StateTest(unittest.TestCase):
@staticmethod
def _get_state(entries):
- state = State()
+ state = AllStates()
default_entries = {"data": MockStateData(), "move": MockStateMove(), "reduction": MockStateReduction(),
"slice": MockStateSliceEvent(), "mask": MockStateMask(), "wavelength": MockStateWavelength(),
"save": MockStateSave(), "scale": MockStateScale(), "adjustment": MockStateAdjustment(),
diff --git a/scripts/test/SANS/state/wavelength_and_pixel_adjustment_test.py b/scripts/test/SANS/state/wavelength_and_pixel_adjustment_test.py
index dcb5218a8a150c661ce52dbf322b533b9095aaab..c3c6380183480335f390f8168f0fd79c50f2a4e3 100644
--- a/scripts/test/SANS/state/wavelength_and_pixel_adjustment_test.py
+++ b/scripts/test/SANS/state/wavelength_and_pixel_adjustment_test.py
@@ -9,9 +9,9 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (RangeStepType, DetectorType, SANSFacility, SANSInstrument)
-from sans.state.data import get_data_builder
-from sans.state.wavelength_and_pixel_adjustment import (StateWavelengthAndPixelAdjustment,
- get_wavelength_and_pixel_adjustment_builder)
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateWavelengthAndPixelAdjustment import (StateWavelengthAndPixelAdjustment,
+ get_wavelength_and_pixel_adjustment_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/state/wavelength_test.py b/scripts/test/SANS/state/wavelength_test.py
index 8fe4210a56385616da84c3722a85a6218d93f73e..410fe192f067c9016543acc4e326449bc0f0d897 100644
--- a/scripts/test/SANS/state/wavelength_test.py
+++ b/scripts/test/SANS/state/wavelength_test.py
@@ -9,8 +9,8 @@ from __future__ import (absolute_import, division, print_function)
import unittest
from sans.common.enums import (SANSFacility, SANSInstrument, RebinType, RangeStepType)
-from sans.state.data import get_data_builder
-from sans.state.wavelength import (StateWavelength, get_wavelength_builder)
+from sans.state.StateObjects.StateData import get_data_builder
+from sans.state.StateObjects.StateWavelength import (StateWavelength, get_wavelength_builder)
from sans.test_helper.file_information_mock import SANSFileInformationMock
diff --git a/scripts/test/SANS/user_file/CMakeLists.txt b/scripts/test/SANS/user_file/CMakeLists.txt
index 529c91188ea2ca0dcc94b6cc55b6be3135c695c8..9cb3b241af7650d7201b03498f4525122769fcea 100644
--- a/scripts/test/SANS/user_file/CMakeLists.txt
+++ b/scripts/test/SANS/user_file/CMakeLists.txt
@@ -3,10 +3,12 @@
set(TEST_PY_FILES
user_file_parser_test.py
user_file_reader_test.py
- state_director_test.py)
+ )
check_tests_valid(${CMAKE_CURRENT_SOURCE_DIR} ${TEST_PY_FILES})
# Prefix for test name=PythonAlgorithms
pyunittest_add_test(${CMAKE_CURRENT_SOURCE_DIR} python.SANS.user_file
${TEST_PY_FILES})
+
+add_subdirectory(txt_parsers)
diff --git a/scripts/test/SANS/user_file/__init__.py b/scripts/test/SANS/user_file/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/scripts/test/SANS/user_file/txt_parsers/CMakeLists.txt b/scripts/test/SANS/user_file/txt_parsers/CMakeLists.txt
new file mode 100644
index 0000000000000000000000000000000000000000..b85ac7b7c3bcbae39f960a647ff9f20c3d2e5422
--- /dev/null
+++ b/scripts/test/SANS/user_file/txt_parsers/CMakeLists.txt
@@ -0,0 +1,7 @@
+set(TEST_PY_FILES
+ ParsedDictConverterTest.py
+)
+
+check_tests_valid(${CMAKE_CURRENT_SOURCE_DIR} ${TEST_PY_FILES})
+
+pyunittest_add_test(${CMAKE_CURRENT_SOURCE_DIR} python.SANS.user_file.txt_parsers ${TEST_PY_FILES})
diff --git a/scripts/test/SANS/user_file/state_director_test.py b/scripts/test/SANS/user_file/txt_parsers/ParsedDictConverterTest.py
similarity index 80%
rename from scripts/test/SANS/user_file/state_director_test.py
rename to scripts/test/SANS/user_file/txt_parsers/ParsedDictConverterTest.py
index 127ef6bfcb477151b0b114ac9c95869f5a4f6b8a..d4af5115bacb8cef578164dba09229e7b8dbacb9 100644
--- a/scripts/test/SANS/user_file/state_director_test.py
+++ b/scripts/test/SANS/user_file/txt_parsers/ParsedDictConverterTest.py
@@ -1,31 +1,51 @@
# Mantid Repository : https://github.com/mantidproject/mantid
#
-# Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
# NScD Oak Ridge National Laboratory, European Spallation Source
# & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
-from __future__ import (absolute_import, division, print_function)
-
import os
import unittest
from sans.common.configurations import Configurations
-from sans.common.enums import (SANSFacility, ReductionMode, RangeStepType, RebinType, DataType, FitType,
- DetectorType, SampleShape, SANSInstrument)
-from sans.state.data import get_data_builder
+from sans.common.enums import DetectorType, SANSInstrument, SANSFacility, ReductionMode, RangeStepType, RebinType, DataType, FitType
+from sans.state.StateObjects.StateData import get_data_builder
from sans.test_helper.file_information_mock import SANSFileInformationMock
from sans.test_helper.user_file_test_helper import create_user_file, sample_user_file
-from sans.user_file.state_director import StateDirectorISIS
+from sans.user_file.txt_parsers.UserFileReaderAdapter import UserFileReaderAdapter
+
+
+class ParsedDictConverterTest(unittest.TestCase):
+ def test_state_can_be_created_from_valid_user_file_with_data_information(self):
+ # Arrange
+ file_information = SANSFileInformationMock(instrument=SANSInstrument.SANS2D, run_number=22024)
+ data_builder = get_data_builder(SANSFacility.ISIS, file_information)
+ data_builder.set_sample_scatter("SANS2D00022024")
+ data_builder.set_sample_scatter_period(3)
+ data_state = data_builder.build()
+
+ user_file_path = create_user_file(sample_user_file)
+
+ parser = UserFileReaderAdapter(user_file_name=user_file_path, data_info=data_state)
+ state = parser.get_all_states()
+
+ # Assert
+ self._assert_data(state)
+ self._assert_move(state)
+ self._assert_mask(state)
+ self._assert_reduction(state)
+ self._assert_wavelength(state)
+ self._assert_scale(state)
+ self._assert_adjustment(state)
+ self._assert_convert_to_q(state)
+ # clean up
+ if os.path.exists(user_file_path):
+ os.remove(user_file_path)
-# -----------------------------------------------------------------
-# --- Tests -------------------------------------------------------
-# -----------------------------------------------------------------
-class UserFileStateDirectorISISTest(unittest.TestCase):
def _assert_data(self, state):
data = state.data
self.assertEqual(data.calibration, "TUBE_SANS2D_BOTH_31681_25Sept15.nxs")
- self.assertEqual(data.user_file, "USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger_FRONT.txt")
def _assert_move(self, state):
move = state.move
@@ -172,70 +192,10 @@ class UserFileStateDirectorISISTest(unittest.TestCase):
# Assert wide angle correction
self.assertTrue(state.adjustment.wide_angle_correction)
- def test_state_can_be_created_from_valid_user_file_with_data_information(self):
- # Arrange
- file_information = SANSFileInformationMock(instrument=SANSInstrument.SANS2D, run_number=22024)
- data_builder = get_data_builder(SANSFacility.ISIS, file_information,
- user_file="USER_SANS2D_154E_2p4_4m_M3_Xpress_8mm_SampleChanger_FRONT.txt")
- data_builder.set_sample_scatter("SANS2D00022024")
- data_builder.set_sample_scatter_period(3)
- data_state = data_builder.build()
- director = StateDirectorISIS(data_state, file_information)
- user_file_path = create_user_file(sample_user_file)
-
- director.set_user_file(user_file_path)
- state = director.construct()
-
- # Assert
- self._assert_data(state)
- self._assert_move(state)
- self._assert_mask(state)
- self._assert_reduction(state)
- self._assert_wavelength(state)
- self._assert_scale(state)
- self._assert_adjustment(state)
- self._assert_convert_to_q(state)
- # clean up
- if os.path.exists(user_file_path):
- os.remove(user_file_path)
- def test_stat_can_be_created_from_valid_user_file_and_later_on_reset(self):
- # Arrange
- file_information = SANSFileInformationMock(instrument=SANSInstrument.SANS2D, run_number=22024)
- data_builder = get_data_builder(SANSFacility.ISIS, file_information)
- data_builder.set_sample_scatter("SANS2D00022024")
- data_builder.set_sample_scatter_period(3)
- data_state = data_builder.build()
-
- director = StateDirectorISIS(data_state, file_information)
- user_file_path = create_user_file(sample_user_file)
- director.set_user_file(user_file_path)
-
- # Set additional items
- director.set_mask_builder_radius_min(0.001298)
- director.set_mask_builder_radius_max(0.003298)
- director.set_scale_builder_width(1.)
- director.set_scale_builder_height(1.5)
- director.set_scale_builder_thickness(12.)
- director.set_scale_builder_shape(SampleShape.FLAT_PLATE)
-
- # Act
- state = director.construct()
-
- # Assert
- self.assertEqual(state.mask.radius_min, 0.001298)
- self.assertEqual(state.mask.radius_max, 0.003298)
- self.assertEqual(state.scale.width, 1.)
- self.assertEqual(state.scale.height, 1.5)
- self.assertEqual(state.scale.thickness, 12.)
- self.assertEqual(state.scale.shape, SampleShape.FLAT_PLATE)
-
- # clean up
- if os.path.exists(user_file_path):
- os.remove(user_file_path)
-if __name__ == "__main__":
+if __name__ == '__main__':
unittest.main()
diff --git a/scripts/test/SANS/user_file/txt_parsers/__init__.py b/scripts/test/SANS/user_file/txt_parsers/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..a352cdce8dd10ff50a564de2b6e4c95bfea3c6d3
--- /dev/null
+++ b/scripts/test/SANS/user_file/txt_parsers/__init__.py
@@ -0,0 +1,6 @@
+# Mantid Repository : https://github.com/mantidproject/mantid
+#
+# Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
+# NScD Oak Ridge National Laboratory, European Spallation Source
+# & Institut Laue - Langevin
+# SPDX - License - Identifier: GPL - 3.0 +