From e69463af6ed99effb71f2b94c82bc4f467af9fab Mon Sep 17 00:00:00 2001
From: Marina Ganeva <m.ganeva@fz-juelich.de>
Date: Thu, 5 Apr 2018 16:09:33 +0200
Subject: [PATCH] Refs #21293 rename parameters and edit code conventions
---
Framework/MDAlgorithms/src/LoadDNSSCD.cpp | 12 ++++++------
Framework/MDAlgorithms/test/LoadDNSSCDTest.h | 16 ++++++++--------
.../tests/analysis/CodeConventions.py | 1 +
docs/source/algorithms/LoadDNSSCD-v1.rst | 6 +++---
4 files changed, 18 insertions(+), 17 deletions(-)
diff --git a/Framework/MDAlgorithms/src/LoadDNSSCD.cpp b/Framework/MDAlgorithms/src/LoadDNSSCD.cpp
index 54701f46623..b413383b09e 100644
--- a/Framework/MDAlgorithms/src/LoadDNSSCD.cpp
+++ b/Framework/MDAlgorithms/src/LoadDNSSCD.cpp
@@ -172,18 +172,18 @@ void LoadDNSSCD::init() {
"OmegaOffset", 0.0,
boost::make_shared<BoundedValidator<double>>(),
Direction::Input),
- "Angle in degrees between (hkl1) and the beam axis"
+ "Angle in degrees between (HKL1) and the beam axis"
"if the goniometer is at zero.");
declareProperty(
- Kernel::make_unique<ArrayProperty<double>>("hkl1", u0, mustBe3D),
+ Kernel::make_unique<ArrayProperty<double>>("HKL1", u0, mustBe3D),
"Indices of the vector in reciprocal space in the horizontal plane at "
"angle Omegaoffset, "
"if the goniometer is at zero.");
declareProperty(
- Kernel::make_unique<ArrayProperty<double>>("hkl2", v0, mustBe3D),
+ Kernel::make_unique<ArrayProperty<double>>("HKL2", v0, mustBe3D),
"Indices of a second vector in reciprocal space in the horizontal plane "
- "not parallel to hkl1");
+ "not parallel to HKL1");
std::vector<double> ttl(2, 0);
ttl[1] = 180.0;
@@ -394,8 +394,8 @@ void LoadDNSSCD::fillOutputWorkspace(double wavelength) {
alpha = getProperty("alpha");
beta = getProperty("beta");
gamma = getProperty("gamma");
- std::vector<double> u = getProperty("hkl1");
- std::vector<double> v = getProperty("hkl2");
+ std::vector<double> u = getProperty("HKL1");
+ std::vector<double> v = getProperty("HKL2");
// estimate extents
double qmax = 4.0 * M_PI / wavelength;
diff --git a/Framework/MDAlgorithms/test/LoadDNSSCDTest.h b/Framework/MDAlgorithms/test/LoadDNSSCDTest.h
index a77cc654395..0771ac15b28 100644
--- a/Framework/MDAlgorithms/test/LoadDNSSCDTest.h
+++ b/Framework/MDAlgorithms/test/LoadDNSSCDTest.h
@@ -192,8 +192,8 @@ public:
TS_ASSERT_THROWS_NOTHING(alg.setProperty("beta", 90.0));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("gamma", 120.0));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("OmegaOffset", -43.0));
- TS_ASSERT_THROWS_NOTHING(alg.setProperty("hkl1", "1,1,0"));
- TS_ASSERT_THROWS_NOTHING(alg.setProperty("hkl2", "0,0,1"));
+ TS_ASSERT_THROWS_NOTHING(alg.setProperty("HKL1", "1,1,0"));
+ TS_ASSERT_THROWS_NOTHING(alg.setProperty("HKL2", "0,0,1"));
TS_ASSERT_THROWS_NOTHING(alg.execute(););
TS_ASSERT(alg.isExecuted());
@@ -320,8 +320,8 @@ public:
TS_ASSERT_THROWS_NOTHING(alg.setProperty("beta", 90.0));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("gamma", 120.0));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("OmegaOffset", -43.0));
- TS_ASSERT_THROWS_NOTHING(alg.setProperty("hkl1", "1,1,0"));
- TS_ASSERT_THROWS_NOTHING(alg.setProperty("hkl2", "0,0,1"));
+ TS_ASSERT_THROWS_NOTHING(alg.setProperty("HKL1", "1,1,0"));
+ TS_ASSERT_THROWS_NOTHING(alg.setProperty("HKL2", "0,0,1"));
TS_ASSERT_THROWS_NOTHING(alg.execute(););
TS_ASSERT(alg.isExecuted());
@@ -406,8 +406,8 @@ public:
TS_ASSERT_THROWS_NOTHING(alg.setProperty("beta", 90.0));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("gamma", 120.0));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("OmegaOffset", -43.0));
- TS_ASSERT_THROWS_NOTHING(alg.setProperty("hkl1", "1,1,0"));
- TS_ASSERT_THROWS_NOTHING(alg.setProperty("hkl2", "0,0,1"));
+ TS_ASSERT_THROWS_NOTHING(alg.setProperty("HKL1", "1,1,0"));
+ TS_ASSERT_THROWS_NOTHING(alg.setProperty("HKL2", "0,0,1"));
TS_ASSERT_THROWS_NOTHING(alg.execute(););
TS_ASSERT(alg.isExecuted());
@@ -588,8 +588,8 @@ public:
TS_ASSERT_THROWS_NOTHING(alg.setProperty("beta", 90.0));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("gamma", 120.0));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("OmegaOffset", -43.0));
- TS_ASSERT_THROWS_NOTHING(alg.setProperty("hkl1", "1,1,0"));
- TS_ASSERT_THROWS_NOTHING(alg.setProperty("hkl2", "0,0,1"));
+ TS_ASSERT_THROWS_NOTHING(alg.setProperty("HKL1", "1,1,0"));
+ TS_ASSERT_THROWS_NOTHING(alg.setProperty("HKL2", "0,0,1"));
TS_ASSERT_THROWS_NOTHING(alg.setProperty("TwoThetaLimits", "20.0,55.0"));
TS_ASSERT_THROWS_NOTHING(alg.execute(););
TS_ASSERT(alg.isExecuted());
diff --git a/Testing/SystemTests/tests/analysis/CodeConventions.py b/Testing/SystemTests/tests/analysis/CodeConventions.py
index d0364e1bcaa..8b0010b9d05 100644
--- a/Testing/SystemTests/tests/analysis/CodeConventions.py
+++ b/Testing/SystemTests/tests/analysis/CodeConventions.py
@@ -23,6 +23,7 @@ ALG_BAD_PARAMS = {
"EstimateDivergence(v1)":("alpha", "beta0", "beta1"),
"FindUBUsingLatticeParameters(v1)":("a", "b", "c", "alpha", "beta", "gamma"),
"IndexSXPeaks(v1)":("a", "b", "c", "alpha", "beta", "gamma", "dTolerance"),
+ "LoadDNSSCD(v1)":("a", "b", "c", "alpha", "beta", "gamma"),
"ModeratorTzero(v1)":("tolTOF"),
"MuscatFunc(v1)":("dQ", "dW"),
"OptimizeCrystalPlacement(v1)":("nPeaks", "nParams", "nIndexed"),
diff --git a/docs/source/algorithms/LoadDNSSCD-v1.rst b/docs/source/algorithms/LoadDNSSCD-v1.rst
index b51b3aa4d45..c0c38a8fdc9 100644
--- a/docs/source/algorithms/LoadDNSSCD-v1.rst
+++ b/docs/source/algorithms/LoadDNSSCD-v1.rst
@@ -76,7 +76,7 @@ Usage
# load data to MDEventWorkspace
ws, ws_norm, huber_ws = LoadDNSSCD(FileNames=filename, NormalizationWorkspace='ws_norm',
Normalization='monitor', a=a, b=b, c=c, alpha=alpha, beta=beta, gamma=gamma,
- OmegaOffset=omega_offset, hkl1=hkl1, hkl2=hkl2, SaveHuberTo='huber_ws')
+ OmegaOffset=omega_offset, HKL1=hkl1, HKL2=hkl2, SaveHuberTo='huber_ws')
# print output workspace information
print("Output Workspace Type is: {}".format(ws.id()))
@@ -133,7 +133,7 @@ Usage
# load data to MDEventWorkspace
ws, ws_norm, huber_ws = LoadDNSSCD(FileNames=filename, NormalizationWorkspace='ws_norm',
Normalization='monitor', a=a, b=b, c=c, alpha=alpha, beta=beta, gamma=gamma,
- OmegaOffset=omega_offset, hkl1=hkl1, hkl2=hkl2, TwoThetaLimits=tth_limits)
+ OmegaOffset=omega_offset, HKL1=hkl1, HKL2=hkl2, TwoThetaLimits=tth_limits)
# print output workspace information
print("Output Workspace Type is: {}".format(ws.id()))
@@ -179,7 +179,7 @@ Usage
# load data to MDEventWorkspace
ws, ws_norm, huber_ws = LoadDNSSCD(FileNames=filename, NormalizationWorkspace='ws_norm',
Normalization='monitor', a=a, b=b, c=c, alpha=alpha, beta=beta, gamma=gamma,
- OmegaOffset=omega_offset, hkl1=hkl1, hkl2=hkl2, LoadHuberFrom=table)
+ OmegaOffset=omega_offset, HKL1=hkl1, HKL2=hkl2, LoadHuberFrom=table)
# print output workspace information
print("Output Workspace Type is: {}".format(ws.id()))
--
GitLab