Skip to content

Commit

Permalink
Refs #8632. Fixing CurveFitting doxygen errors.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Reuter committed Dec 20, 2013
1 parent 922d834 commit 4b69262
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 281 deletions.
Expand Up @@ -12,9 +12,9 @@ namespace Mantid
{
/**
Provide lorentzian peak shape function interface to IPeakFunction.
I.e. the function: <math>\frac{A}{\pi}( \Gamma/2((x-PeakCentre)^2+(\Gamma/2)^2) ).
I.e. the function: \f$ \frac{A}{\pi}( \Gamma/2((x-PeakCentre)^2+(\Gamma/2)^2) )\f$.
\Gamma/2 (HWHM) - half-width at half-maximum
\f$\Gamma/2\f$ (HWHM) - half-width at half-maximum
Lorentzian parameters:
<UL>
Expand Down
Expand Up @@ -301,9 +301,11 @@ namespace Mantid
}

/**
* @param lambda
* @param mu
* @param rho
* @param xcur The starting parameters for the limited unconstrained optimization. They will
* be updated as it proceeds
* @param d
* be updated as it proceeds
*/
void AugmentedLagrangianOptimizer::unconstrainedOptimization(const std::vector<double> & lambda,
const std::vector<double> & mu,
Expand Down
Expand Up @@ -307,7 +307,6 @@ namespace CurveFitting
}

/**
* @param funcIndex Index within composite
* @param profile Function of type ComptonProfile
* @param paramsOffset The offset of the given function's parameters within composite
*/
Expand All @@ -325,7 +324,6 @@ namespace CurveFitting
}

/**
* @param funcIndex Index within composite
* @param function1D Function of type IFunction1D
* @param paramsOffset The offset of the given function's parameters within composite
*/
Expand Down
5 changes: 2 additions & 3 deletions Code/Mantid/Framework/CurveFitting/src/CubicSpline.cpp
Expand Up @@ -190,9 +190,8 @@ namespace Mantid

/**Evaluate a point on the spline. Includes basic error handling
*
* @param out :: The array to store the calculated values
* @param xValues :: The array of x values we wish to interpolate
* @param nData :: The size of the arrays
* @param x :: Point to evaluate
* @return :: the value of the spline at the given point
*/
double CubicSpline::splineEval(const double x) const
{
Expand Down
14 changes: 10 additions & 4 deletions Code/Mantid/Framework/CurveFitting/src/LeBailFunction.cpp
Expand Up @@ -112,7 +112,8 @@ namespace CurveFitting
/** Calculate powder diffraction pattern by Le Bail algorithm
* @param out :: output vector
* @param xvalues :: input vector
* @param includebkgd :: if true, then calculate background and add to output. otherwise, assume zero background
* @param calpeaks :: if true, calculate peaks
* @param calbkgd :: if true, then calculate background and add to output. otherwise, assume zero background
*/
void LeBailFunction::function(std::vector<double>& out, const std::vector<double>& xvalues, bool calpeaks, bool calbkgd) const
{
Expand Down Expand Up @@ -179,7 +180,7 @@ namespace CurveFitting

//----------------------------------------------------------------------------------------------
/** Check whether a parameter is a profile parameter
* @param parammane :: parameter name to check with
* @param paramname :: parameter name to check with
*/
bool LeBailFunction::hasProfileParameter(std::string paramname)
{
Expand Down Expand Up @@ -256,7 +257,9 @@ namespace CurveFitting

//----------------------------------------------------------------------------------------------
/** Set peak position tolerance during importing/adding peaks
* @param peakhkls :: list of Miller indexes (HKL)
* @param peakpostol :: tolerance for peak position
* @param tofmin :: minimum TOF for peak position
* @param tofmax :: maximum TOF for peak position
*/
void LeBailFunction::setPeakCentreTolerance(double peakpostol, double tofmin, double tofmax)
{
Expand Down Expand Up @@ -777,6 +780,7 @@ namespace CurveFitting
//----------------------------------------------------------------------------------------------
/** Group peaks together
* @param peakgroupvec: output vector containing peaks grouped together.
* @param outboundpeakvec: output vector containing peaks out of bound range
* @param xmin : minimim x value of the data
* @param xmax : maximum x value of the data
* Disabled argument: MatrixWorkspace_sptr dataws, size_t workspaceindex,
Expand Down Expand Up @@ -902,6 +906,8 @@ namespace CurveFitting
/** Add background function.
* The supported background types are Polynomial/Linear/Flat and Chebyshev
* @param backgroundtype :: string, type of background, such as Polynomial, Chebyshev
* @param order :: polynomial order for the background
* @param vecparnames :: vector of parameter names
* @param vecparvalues :: vector of parameter values from order 0.
* @param startx :: background's StartX. Used by Chebyshev
* @param endx :: background's EndX. Used by Chebyshev
Expand Down Expand Up @@ -1046,7 +1052,7 @@ namespace CurveFitting

//----------------------------------------------------------------------------------------------
/** Reset all peaks' height
* @param peakheights :: list of peak heights corresponding to each peak
* @param inheights :: list of peak heights corresponding to each peak
*/
void LeBailFunction::setPeakHeights(std::vector<double> inheights)
{
Expand Down
266 changes: 0 additions & 266 deletions Code/Mantid/Framework/CurveFitting/src/Linear.cpp

This file was deleted.

2 changes: 1 addition & 1 deletion Code/Mantid/Framework/CurveFitting/src/SeqDomain.cpp
Expand Up @@ -101,7 +101,7 @@ void SeqDomain::leastSquaresVal(const CostFuncLeastSquares& leastSquares)
//------------------------------------------------------------------------------------------------
/**
* Calculate the value of a least squares cost function
* @param leastSquares :: The least squares cost func to calculate the value for
* @param rwp :: The RWP cost func to calculate the value for
*/
void SeqDomain::rwpVal(const CostFuncRwp& rwp)
{
Expand Down
Expand Up @@ -248,7 +248,6 @@ namespace Mantid
* @param inputWorkspace :: The input workspace
* @param outputWorkspace :: The output workspace
* @param order :: The order of derivatives to calculate
* @param row :: The row of spectra to use
*/
void SplineInterpolation::calculateDerivatives(API::MatrixWorkspace_const_sptr inputWorkspace,
API::MatrixWorkspace_sptr outputWorkspace, int order) const
Expand Down

0 comments on commit 4b69262

Please sign in to comment.