Re #5804. Clarify absorption correction properties.

Our property called "AttenuationXSection" really refers to the absorption cross-section, so make sure the descriptions says so.
mantidproject · Aug 27, 2012 · 926df2c · 926df2c
1 parent 32927f8
commit 926df2c
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/Code/Mantid/Framework/Algorithms/src/AbsorptionCorrection.cpp b/Code/Mantid/Framework/Algorithms/src/AbsorptionCorrection.cpp
@@ -57,9 +57,9 @@ void AbsorptionCorrection::init()
   auto mustBePositive = boost::make_shared<BoundedValidator<double> >();
   mustBePositive->setLower(0.0);
   declareProperty("AttenuationXSection", -1.0, mustBePositive,
-    "The attenuation cross-section for the sample material in barns");
+    "The ABSORPTION cross-section for the sample material in barns");
   declareProperty("ScatteringXSection", -1.0, mustBePositive,
-    "The scattering cross-section for the sample material in barns");
+    "The scattering cross-section (coherent + incoherent) for the sample material in barns");
   declareProperty("SampleNumberDensity", -1.0, mustBePositive,
     "The number density of the sample in number per cubic angstrom");
 

diff --git a/Code/Mantid/Framework/Algorithms/src/HRPDSlabCanAbsorption.cpp b/Code/Mantid/Framework/Algorithms/src/HRPDSlabCanAbsorption.cpp
@@ -50,9 +50,9 @@ void HRPDSlabCanAbsorption::init()
   auto mustBePositive = boost::make_shared<BoundedValidator<double> >();
   mustBePositive->setLower(0.0);
   declareProperty("SampleAttenuationXSection", -1.0, mustBePositive,
-    "The attenuation cross-section for the sample material in barns");
+    "The ABSORPTION cross-section for the sample material in barns");
   declareProperty("SampleScatteringXSection", -1.0, mustBePositive,
-    "The scattering cross-section for the sample material in barns");
+    "The scattering cross-section (coherent + incoherent) for the sample material in barns");
   declareProperty("SampleNumberDensity", -1.0, mustBePositive,
     "The number density of the sample in number per cubic angstrom");
 

diff --git a/Code/Mantid/Framework/Algorithms/src/SphericalAbsorption.cpp b/Code/Mantid/Framework/Algorithms/src/SphericalAbsorption.cpp
@@ -58,9 +58,9 @@ void SphericalAbsorption::init()
   auto mustBePositive = boost::make_shared<BoundedValidator<double> >();
   mustBePositive->setLower(0.0);
   declareProperty("AttenuationXSection", -1.0, mustBePositive,
-    "The attenuation cross-section for the sample material in barns");
+    "The ABSORPTION cross-section for the sample material in barns");
   declareProperty("ScatteringXSection", -1.0, mustBePositive,
-    "The scattering cross-section for the sample material in barns");
+    "The scattering cross-section (coherent + incoherent) for the sample material in barns");
   declareProperty("SampleNumberDensity", -1.0, mustBePositive,
     "The number density of the sample in number per cubic angstrom");
   declareProperty("SphericalSampleRadius", -1.0, mustBePositive,