Refs #5027. Changed name to fwhm.

mantidproject · Mar 27, 2012 · 0d3c843 · 0d3c843
1 parent 875ce63
commit 0d3c843
Show file tree

Hide file tree

Showing 31 changed files with 87 additions and 88 deletions.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/IPeakFunction.h b/Code/Mantid/Framework/API/inc/MantidAPI/IPeakFunction.h
@@ -42,10 +42,10 @@ class MANTID_API_DLL IPeakFunction : public IFunctionWithLocation
   /// Constructor
   IPeakFunction();
   /// Returns the peak FWHM
-  virtual double width()const = 0;
+  virtual double fwhm()const = 0;
 
   /// Sets the parameters such that FWHM = w
-  virtual void setWidth(const double w) = 0;
+  virtual void setFwhm(const double w) = 0;
 
   /// General implementation of the method for all peaks. 
   void functionMW(double* out, const double* xValues, const size_t nData)const;

diff --git a/Code/Mantid/Framework/API/src/IPeakFunction.cpp b/Code/Mantid/Framework/API/src/IPeakFunction.cpp
@@ -74,7 +74,7 @@ IPeakFunction::IPeakFunction()
 void IPeakFunction::functionMW(double* out, const double* xValues, const size_t nData)const
 {
   double c = this->centre();
-  double dx = fabs(s_peakRadius*this->width());
+  double dx = fabs(s_peakRadius*this->fwhm());
   int i0 = -1;
   int n = 0;
   for(size_t i = 0; i < nData; ++i)
@@ -106,7 +106,7 @@ void IPeakFunction::functionMW(double* out, const double* xValues, const size_t
 void IPeakFunction::functionDerivMW(Jacobian* out, const double* xValues, const size_t nData)
 {
   double c = this->centre();
-  double dx = fabs(s_peakRadius*this->width());
+  double dx = fabs(s_peakRadius*this->fwhm());
   int i0 = -1;
   int n = 0;
   for(size_t i = 0; i < nData; ++i)

diff --git a/Code/Mantid/Framework/API/test/CompositeFunctionTest.h b/Code/Mantid/Framework/API/test/CompositeFunctionTest.h
@@ -138,7 +138,7 @@ class Gauss: public IPeakFunction, public CompositeFunctionTest_IFunction
     return getParameter(1);
   }
 
-  double width()const
+  double fwhm()const
   {
     return getParameter(2);
   }
@@ -152,7 +152,7 @@ class Gauss: public IPeakFunction, public CompositeFunctionTest_IFunction
     setParameter(1,h);
   }
 
-  void setWidth(const double w)
+  void setFwhm(const double w)
   {
     setParameter(2,w);
   }

diff --git a/Code/Mantid/Framework/API/test/ParameterTieTest.h b/Code/Mantid/Framework/API/test/ParameterTieTest.h
@@ -58,7 +58,7 @@ class ParameterTieTest_Gauss: public IPeakFunction
     return getParameter(1);
   }
 
-  double width()const
+  double fwhm()const
   {
     return getParameter(2);
   }
@@ -72,7 +72,7 @@ class ParameterTieTest_Gauss: public IPeakFunction
     setParameter(1,h);
   }
 
-  void setWidth(const double w)
+  void setFwhm(const double w)
   {
     setParameter(2,w);
   }

diff --git a/Code/Mantid/Framework/Algorithms/src/FindPeaks.cpp b/Code/Mantid/Framework/Algorithms/src/FindPeaks.cpp
@@ -1214,7 +1214,6 @@ void FindPeaks::addRow(const int spectrum, const std::vector<double> &params, co
  * @param effParams This will always be centre, width, height, backA0, backA1, backA2 reguarless of how many
  * parameters the function actually has.
  * @param rawParams The actual parameters of the fit function.
- * @param peakFuncType Since this is a static method.
  */
 void getComponentFunctions(IFitFunction_sptr compositeFunc, std::vector<double> &effParams, std::vector<double> &rawParams, const std::string & peakFuncType)
 {
@@ -1257,7 +1256,7 @@ void getComponentFunctions(IFitFunction_sptr compositeFunc, std::vector<double>
     if (peakFuncType.compare("Gaussian") == 0) // TODO stupid hack because "width" is FWHM rather than sigma
       effParams[1] = peakFunc->getParameter(2);
     else
-      effParams[1] = peakFunc->width();
+      effParams[1] = peakFunc->fwhm();
     effParams[2] = peakFunc->height();
   }
   if (backFunc)
@@ -1369,7 +1368,7 @@ IFitFunction_sptr FindPeaks::createFunction(const double height, const double ce
     IPeakFunction *peakFunc = dynamic_cast<IPeakFunction *>(tempPeakFunc);
     peakFunc->setHeight(height);
     peakFunc->setCentre(centre);
-    peakFunc->setWidth(sigma);
+    peakFunc->setFwhm(sigma);
 
     // put the two together and return
     CompositeFunctionMW* fitFunc = new  CompositeFunctionMW();

diff --git a/Code/Mantid/Framework/Algorithms/src/GetDetectorOffsets.cpp b/Code/Mantid/Framework/Algorithms/src/GetDetectorOffsets.cpp
@@ -242,7 +242,7 @@ namespace Mantid
       peak->setHeight(peakHeight);
       peak->setCentre(peakLoc);
       const double sigma(10.0);
-      peak->setWidth(2.0*std::sqrt(2.0*std::log(2.0))*sigma);
+      peak->setFwhm(2.0*std::sqrt(2.0*std::log(2.0))*sigma);
 
       CompositeFunctionMW* fitFunc = new CompositeFunctionMW(); //Takes ownership of the functions
       fitFunc->addFunction(background);

diff --git a/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/BackToBackExponential.h b/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/BackToBackExponential.h
@@ -58,10 +58,10 @@ namespace Mantid
       /// overwrite IPeakFunction base class methods
       virtual double centre()const {return getParameter("X0");};
       virtual double height()const {return getParameter("I");};  // note height can likely be defined more accurately, here set equal to intensity 
-      virtual double width()const {return 2*getParameter("S");};  // can likely be defined more accurately
+      virtual double fwhm()const {return 2*getParameter("S");};  // can likely be defined more accurately
       virtual void setCentre(const double c) {setParameter("X0",c);};
       virtual void setHeight(const double h) {setParameter("I",h);};
-      virtual void setWidth(const double w) {setParameter("S",w/2.0);};
+      virtual void setFwhm(const double w) {setParameter("S",w/2.0);};
 
 
       /// overwrite IFunction base class methods

diff --git a/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/DeltaFunction.h b/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/DeltaFunction.h
@@ -51,10 +51,10 @@ namespace Mantid
       /// overwrite IPeakFunction base class methods
       virtual double centre()const {return 0;}
       virtual double height()const {return getParameter("Height");}
-      virtual double width()const {return 0;}
+      virtual double fwhm()const {return 0;}
       virtual void setCentre(const double c) { UNUSED_ARG(c); }
       virtual void setHeight(const double h) {setParameter("Height",h);}
-      virtual void setWidth(const double w) { UNUSED_ARG(w); }
+      virtual void setFwhm(const double w) { UNUSED_ARG(w); }
       virtual double HeightPrefactor()const { return 1.0; }  //modulates the Height of the Delta function
       /// overwrite IFunction base class methods
       std::string name()const{return "DeltaFunction";}

diff --git a/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/Gaussian.h b/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/Gaussian.h
@@ -58,10 +58,10 @@ namespace Mantid
       /// overwrite IPeakFunction base class methods
       virtual double centre()const {return getParameter("PeakCentre");}
       virtual double height()const {return getParameter("Height");}
-      virtual double width()const {return 2.0*sqrt(2.0*std::log(2.0))*getParameter("Sigma");}
+      virtual double fwhm()const {return 2.0*sqrt(2.0*std::log(2.0))*getParameter("Sigma");}
       virtual void setCentre(const double c) {setParameter("PeakCentre",c);}
       virtual void setHeight(const double h) {setParameter("Height",h);}
-      virtual void setWidth(const double w) {setParameter("Sigma",w/(2.0*sqrt(2.0*std::log(2.0))));}
+      virtual void setFwhm(const double w) {setParameter("Sigma",w/(2.0*sqrt(2.0*std::log(2.0))));}
 
 
       /// overwrite IFunction base class methods

diff --git a/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/IkedaCarpenterPV.h b/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/IkedaCarpenterPV.h
@@ -49,10 +49,10 @@ namespace Mantid
       /// overwrite IPeakFunction base class methods
       virtual double centre()const;
       virtual double height()const;
-      virtual double width()const;
+      virtual double fwhm()const;
       virtual void setCentre(const double c);
       virtual void setHeight(const double h);
-      virtual void setWidth(const double w);
+      virtual void setFwhm(const double w);
 
       /// overwrite IFunction base class methods
       std::string name()const{return "IkedaCarpenterPV";}

diff --git a/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/Lorentzian.h b/Code/Mantid/Framework/CurveFitting/inc/MantidCurveFitting/Lorentzian.h
@@ -55,10 +55,10 @@ namespace Mantid
       /// overwrite IPeakFunction base class methods
       virtual double centre()const {return getParameter("PeakCentre");}
       virtual double height()const {return getParameter("Height");}
-      virtual double width()const {return 2*getParameter("HWHM");}
+      virtual double fwhm()const {return 2*getParameter("HWHM");}
       virtual void setCentre(const double c) {setParameter("PeakCentre",c);}
       virtual void setHeight(const double h) {setParameter("Height",h);}
-      virtual void setWidth(const double w) {setParameter("HWHM",w/2.0);}
+      virtual void setFwhm(const double w) {setParameter("HWHM",w/2.0);}
 
 
       /// overwrite IFunction base class methods

diff --git a/Code/Mantid/Framework/CurveFitting/src/IkedaCarpenterPV.cpp b/Code/Mantid/Framework/CurveFitting/src/IkedaCarpenterPV.cpp
@@ -65,7 +65,7 @@ double IkedaCarpenterPV::height()const
   return h0;
 };
 
-double IkedaCarpenterPV::width()const 
+double IkedaCarpenterPV::fwhm()const
 {
   double sigmaSquared = getParameter("SigmaSquared");
   double gamma = getParameter("Gamma");
@@ -89,7 +89,7 @@ double IkedaCarpenterPV::width()const
   return sqrt(8.0*M_LN2*sigmaSquared)+gamma;
 };
 
-void IkedaCarpenterPV::setWidth(const double w) 
+void IkedaCarpenterPV::setFwhm(const double w)
 {
   setParameter("SigmaSquared", w*w/(32.0*M_LN2));  // used 4.0 * 8.0 = 32.0
   setParameter("Gamma", w/2.0);

diff --git a/Code/Mantid/Framework/CurveFitting/test/CompositeFunctionTest.h b/Code/Mantid/Framework/CurveFitting/test/CompositeFunctionTest.h
@@ -76,7 +76,7 @@ class CurveFittingGauss: public IPeakFunction, public ITestFunction
     return getParameter(1);
   }
 
-  double width()const
+  double fwhm()const
   {
     return getParameter(2);
   }
@@ -90,7 +90,7 @@ class CurveFittingGauss: public IPeakFunction, public ITestFunction
     setParameter(1,h);
   }
 
-  void setWidth(const double w)
+  void setFwhm(const double w)
   {
     setParameter(2,w);
   }

diff --git a/Code/Mantid/Framework/CurveFitting/test/ConvolutionTest.h b/Code/Mantid/Framework/CurveFitting/test/ConvolutionTest.h
@@ -86,7 +86,7 @@ class ConvolutionTest_Gauss: public IPeakFunction
     return getParameter(1);
   }
 
-  double width()const
+  double fwhm()const
   {
     return getParameter(2);
   }
@@ -100,7 +100,7 @@ class ConvolutionTest_Gauss: public IPeakFunction
     setParameter(1,h);
   }
 
-  void setWidth(const double w)
+  void setFwhm(const double w)
   {
     setParameter(2,w);
   }

diff --git a/Code/Mantid/Framework/CurveFitting/test/DeltaFunctionTest.h b/Code/Mantid/Framework/CurveFitting/test/DeltaFunctionTest.h
@@ -66,7 +66,7 @@ class DeltaFunctionTest_Gauss: public IPeakFunction
     return getParameter(1);
   }
 
-  double width()const
+  double fwhm()const
   {
     return getParameter(2);
   }
@@ -80,7 +80,7 @@ class DeltaFunctionTest_Gauss: public IPeakFunction
     setParameter(1,h);
   }
 
-  void setWidth(const double w)
+  void setFwhm(const double w)
   {
     setParameter(2,w);
   }

diff --git a/Code/Mantid/Framework/CurveFitting/test/DiffSphereTest.h b/Code/Mantid/Framework/CurveFitting/test/DiffSphereTest.h
@@ -67,7 +67,7 @@ class DiffSphereTest_Gauss: public IPeakFunction
     return getParameter(1);
   }
 
-  double width()const
+  double fwhm()const
   {
     return getParameter(2);
   }
@@ -81,7 +81,7 @@ class DiffSphereTest_Gauss: public IPeakFunction
     setParameter(1,h);
   }
 
-  void setWidth(const double w)
+  void setFwhm(const double w)
   {
     setParameter(2,w);
   }

diff --git a/Code/Mantid/Framework/CurveFitting/test/FitTest.h b/Code/Mantid/Framework/CurveFitting/test/FitTest.h
@@ -90,7 +90,7 @@ class FitTest_Gauss: public IPeakFunction
     return getParameter(1);
   }
 
-  double width()const
+  double fwhm()const
   {
     return getParameter(2);
   }
@@ -104,7 +104,7 @@ class FitTest_Gauss: public IPeakFunction
     setParameter(1,h);
   }
 
-  void setWidth(const double w)
+  void setFwhm(const double w)
   {
     setParameter(2,w);
   }

diff --git a/Code/Mantid/Framework/CurveFitting/test/FunctionTest.h b/Code/Mantid/Framework/CurveFitting/test/FunctionTest.h
@@ -67,7 +67,7 @@ class FunctionTestGauss: public IPeakFunction
     return getParameter(1);
   }
 
-  double width()const
+  double fwhm()const
   {
     return getParameter(2);
   }
@@ -81,7 +81,7 @@ class FunctionTestGauss: public IPeakFunction
     setParameter(1,h);
   }
 
-  void setWidth(const double w)
+  void setFwhm(const double w)
   {
     setParameter(2,w);
   }