BivariateNormal.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/IFunction1D.h"
#include "MantidAPI/IFunctionMW.h"
#include "MantidAPI/ParamFunction.h"
#include "MantidCurveFitting/Constraints/BoundaryConstraint.h"
#include "MantidCurveFitting/Functions/UserFunction.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
namespace HistogramData {
class HistogramY;
}
namespace CurveFitting {
namespace Functions {
 
class MANTID_CURVEFITTING_DLL BivariateNormal : public API::ParamFunction,
                                                public API::IFunction1D,
                                                public API::IFunctionMW {
public:
  BivariateNormal();
  ~BivariateNormal() override;
 
  std::string name() const override { return "BivariateNormal"; }
 
  const std::string category() const override { return "Peak"; }
 
  void function1D(double *out, const double *xValues, const size_t nData) const override;
 
  void functionDeriv1D(API::Jacobian *out, const double *xValues, const size_t nData) override;
 
  size_t nAttributes() const override { return (size_t)1; }
 
  std::vector<std::string> getAttributeNames() const override {
    std::vector<std::string> V;
    V.emplace_back("CalcVariances");
    return V;
  }
 
  Attribute getAttribute(const std::string &attName) const override {
    if (!hasAttribute(attName))
      throw std::invalid_argument("Not a valid attribute name");
 
    // if( CalcVariances)
    //  return Attribute( 1);
 
    return Attribute(CalcVariances);
  }
 
  void setAttribute(const std::string &attName, const Attribute &value) override {
 
    if (!hasAttribute(attName))
      throw std::invalid_argument("Not a valid attribute name");
 
    CalcVariances = value.asBool();
 
    if (CalcVariances) {
      CalcVxx = CalcVyy = CalcVxy = true;
    } else {
      declareParameter("SScol", 0.00, "Variance of the column(x) values");
      declareParameter("SSrow", 0.00, "Variance of the row(y) values");
      declareParameter("SSrc", 0.00, "Covariance of the column(x) and row(y) values");
      CalcVxx = CalcVyy = CalcVxy = false;
    }
  }
 
  bool hasAttribute(const std::string &attName) const override { return attName == "CalcVariances"; }
 
  bool CalcVxx, CalcVyy, CalcVxy;
 
protected:
  void init() override;
 
  int NCells;
 
  bool CalcVariances; 
 
  double initCommon(); 
 
  // Returns penalty.
  double initCoeff(const HistogramData::HistogramY &D, const HistogramData::HistogramY &X,
                   const HistogramData::HistogramY &Y, double &coefNorm, double &expCoeffx2, double &expCoeffy2,
                   double &expCoeffxy, int &NCells, double &Varxx, double &Varxy, double &Varyy) const;
 
  double mIx, mx, mIy, my;                //< For calculating variances
  double SIxx, SIyy, SIxy, Sxx, Syy, Sxy; //< For calculating variances
  double TotI, TotN;                      //< For calculating variances
 
  double Varx0, Vary0; // Crude estimate of the variances for bounds on
                       // variances
 
  double LastParams[9]; 
 
  double *expVals; 
 
  double uu, coefNorm, expCoeffx2, expCoeffy2,
      expCoeffxy; //<Other common values used in calculating values and
                  //<derivatives
};
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid