mantid convention fix

mantidproject · Feb 7, 2025 · 3fedbca · 3fedbca
1 parent bab805a
commit 3fedbca
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/Framework/MDAlgorithms/src/DebyeWallerFactorCorrectionMD.cpp b/Framework/MDAlgorithms/src/DebyeWallerFactorCorrectionMD.cpp
@@ -41,7 +41,7 @@ void DebyeWallerFactorCorrectionMD::init() {
   QTransform::init();
   auto mustBePositive = std::make_shared<BoundedValidator<double>>();
   mustBePositive->setLower(0.0);
-  declareProperty(std::make_unique<PropertyWithValue<double>>("Mean squared displacement", EMPTY_DBL(),
+  declareProperty(std::make_unique<PropertyWithValue<double>>("MeanSquaredDisplacement", EMPTY_DBL(),
                                                               std::move(mustBePositive), Direction::Input),
                   "Mandatory: Mean squared displacement <u^2>. Often obtained from Rietveld refinement.");
 }
@@ -53,7 +53,7 @@ void DebyeWallerFactorCorrectionMD::exec() { QTransform::exec(); }
 
 // implement correction method
 double DebyeWallerFactorCorrectionMD::correction(const double q2) const {
-  const double u2 = getProperty("Mean squared displacement");
+  const double u2 = getProperty("MeanSquaredDisplacement");
   const double inverse_DWF = exp(u2 * q2 / 3.0);
   return inverse_DWF;
 }

diff --git a/Framework/MDAlgorithms/test/DebyeWallerFactorCorrectionMDTest.h b/Framework/MDAlgorithms/test/DebyeWallerFactorCorrectionMDTest.h
@@ -51,7 +51,7 @@ class DebyeWallerFactorCorrectionMDTest : public CxxTest::TestSuite {
     TS_ASSERT(alg.isInitialized())
     TS_ASSERT_THROWS_NOTHING(alg.setProperty("InputWorkspace", inputWS));
     TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("OutputWorkspace", "_unused_for_child"));
-    TS_ASSERT_THROWS_NOTHING(alg.setProperty("Mean squared displacement", 0.1));
+    TS_ASSERT_THROWS_NOTHING(alg.setProperty("MeanSquaredDisplacement", 0.1));
     TS_ASSERT_THROWS_NOTHING(alg.execute(););
     TS_ASSERT(alg.isExecuted());
     Mantid::API::IMDEventWorkspace_sptr outputWS = alg.getProperty("OutputWorkspace");
@@ -100,7 +100,7 @@ class DebyeWallerFactorCorrectionMDTest : public CxxTest::TestSuite {
     TS_ASSERT(alg.isInitialized())
     TS_ASSERT_THROWS_NOTHING(alg.setProperty("InputWorkspace", inputWS));
     TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("OutputWorkspace", "_unused_for_child"));
-    TS_ASSERT_THROWS_NOTHING(alg.setProperty("Mean squared displacement", "0.15"));
+    TS_ASSERT_THROWS_NOTHING(alg.setProperty("MeanSquaredDisplacement", "0.15"));
     TS_ASSERT_THROWS_NOTHING(alg.execute(););
     TS_ASSERT(alg.isExecuted());
     Mantid::API::IMDEventWorkspace_sptr outputWS = alg.getProperty("OutputWorkspace");

diff --git a/docs/source/algorithms/DebyeWallerFactorCorrectionMD-v1.rst b/docs/source/algorithms/DebyeWallerFactorCorrectionMD-v1.rst
@@ -11,9 +11,9 @@ Description
 -----------
 
 Scales the the signal and error of MD events by the inverse of Debye-Waller Factor :math:`exp(<q>^2 \times <u^2>)` where :math:`<u^2>` is
-the `Mean squared displacement`.
+the `MeanSquaredDisplacement`.
 
-`Mean squared displacement` must be a positive float number.
+`MeanSquaredDisplacement` must be a positive float number.
 
 Input workspace must be in Q with either 1 dimension of \|Q\| or 3 Q_sample/Q_lab dimensions.
 It is assumed that the Q dimensions come first follow by any number of other dimensions.