Provide peak shape function interface a Peak shape on one time slice of a RectangularDetector. More...

#include <BivariateNormal.h>

Inheritance diagram for Mantid::CurveFitting::Functions::BivariateNormal:

Public Member Functions
	BivariateNormal ()

const std::string	category () const override
	The categories the Fit function belong to. More...

void	function1D (double out, const double xValues, const size_t nData) const override
	Function you want to fit to. More...

void	functionDeriv1D (API::Jacobian out, const double xValues, const size_t nData) override
	Derivatives of function with respect to active parameters. More...

Attribute	getAttribute (const std::string &attName) const override
	Return a value of attribute attName. More...

std::vector< std::string >	getAttributeNames () const override
	Returns a list of attribute names. More...

bool	hasAttribute (const std::string &attName) const override
	Check if attribute attName exists. More...

std::string	name () const override
	overwrite IFunction base class methods More...

size_t	nAttributes () const override
	Returns the number of attributes associated with the function. More...

void	setAttribute (const std::string &attName, const Attribute &value) override
	Set a value to attribute attName. More...

	~BivariateNormal () override
	Destructor. More...

Public Member Functions inherited from Mantid::API::ParamFunction
IFunction_sptr	getContainingFunction (const ParameterReference &ref) const
	Get the containing function. More...

IFunction_sptr	getContainingFunction (IFunction_sptr fun)
	Get the containing function. More...

double	getError (const std::string &name) const override
	Get the fitting error for a parameter by name. More...

double	getError (size_t i) const override
	Get the fitting error for a parameter. More...

double	getParameter (const std::string &name) const override
	Get parameter by name. More...

double	getParameter (size_t i) const override
	Get i-th parameter. More...

size_t	getParameterIndex (const ParameterReference &ref) const override
	Return parameter index from a parameter reference. More...

bool	hasParameter (const std::string &name) const override
	Check if function has a parameter with this name. More...

bool	isExplicitlySet (size_t i) const override
	Checks if a parameter has been set explicitly. More...

size_t	nParams () const override
	Total number of parameters. More...

std::string	parameterDescription (size_t i) const override
	Returns the description of parameter i. More...

size_t	parameterIndex (const std::string &name) const override
	Returns the index of parameter name. More...

std::string	parameterName (size_t i) const override
	Returns the name of parameter i. More...

	ParamFunction ()
	Default constructor. More...

void	setError (const std::string &name, double err) override
	Set the fitting error for a parameter by name. More...

void	setError (size_t i, double err) override
	Set the fitting error for a parameter. More...

void	setParameter (const std::string &name, const double &value, bool explicitlySet=true) override
	Set parameter by name. More...

void	setParameter (size_t, const double &value, bool explicitlySet=true) override
	Set i-th parameter. More...

void	setParameterDescription (const std::string &name, const std::string &description) override
	Set description of parameter by name. More...

void	setParameterDescription (size_t, const std::string &description) override
	Set i-th parameter description. More...

Public Member Functions inherited from Mantid::API::IFunction
std::string	asString () const
	Writes itself into a string. More...

bool	cancellationRequestReceived () const
	Returns true if a progress reporter is set & evalaution has been requested to stop. More...

virtual const std::vector< std::string >	categories () const
	Function to return all of the categories that contain this algorithm. More...

virtual const std::string	category () const
	The categories the Fit function belong to. More...

virtual const std::string	categorySeparator () const
	Function to return the sperator token for the category string. More...

virtual std::shared_ptr< IFunction >	clone () const
	Virtual copy constructor. More...

virtual int64_t	estimateNoProgressCalls () const
	Returns an estimate of the number of progress reports a single evaluation of the function will have. More...

virtual void	function (const FunctionDomain &domain, FunctionValues &values) const =0
	Evaluates the function for all arguments in the domain. More...

virtual void	functionDeriv (const FunctionDomain &domain, Jacobian &jacobian)
	Derivatives of function with respect to active parameters. More...

	IFunction ()
	Constructor. More...

	IFunction (const IFunction &)=delete
	No copying. More...

virtual void	initialize ()
	Iinialize the function. More...

virtual void	iterationFinished ()
	Called at the end of an iteration. More...

virtual void	iterationStarting ()
	Called at the start of each iteration. More...

virtual std::string	name () const =0
	Returns the function's name. More...

IFunction &	operator= (const IFunction &)=delete
	No copying. More...

virtual void	registerFunctionUsage (bool internal)
	Registers the usage of the algorithm with the UsageService. More...

void	reportProgress (const std::string &msg="") const
	Reports progress with an optional message. More...

virtual void	setMatrixWorkspace (std::shared_ptr< const API::MatrixWorkspace > workspace, size_t wi, double startX, double endX)
	Set matrix workspace. More...

void	setProgressReporter (std::shared_ptr< Kernel::ProgressBase > reporter)
	Attach a progress reporter. More...

virtual void	setWorkspace (std::shared_ptr< const Workspace > ws)
	Set the workspace. More...

virtual	~IFunction ()
	Virtual destructor. More...

bool	isFixed (size_t i) const
	Check if a parameter i is fixed. More...

bool	isFixedByDefault (size_t i) const
	Check if a parameter i is fixed by default (not by user). More...

void	fix (size_t i, bool isDefault=false)
	Removes a parameter i from the list of active. More...

void	unfix (size_t i)
	Restores a declared parameter i to the active status. More...

void	fixParameter (const std::string &name, bool isDefault=false)
	Fix a parameter. More...

void	unfixParameter (const std::string &name)
	Free a parameter. More...

void	fixAll (bool isDefault=false)
	Fix all parameters. More...

void	unfixAll ()
	Free all parameters. More...

void	unfixAllDefault ()
	Free all parameters fixed by default. More...

void	fixAllActive (bool isDefault=false)
	Fix all active parameters. More...

std::vector< std::string >	getParameterNames () const
	Return a vector with all parameter names. More...

virtual double	activeParameter (size_t i) const
	Value of i-th active parameter. More...

virtual void	setActiveParameter (size_t i, double value)
	Set new value of i-th active parameter. More...

virtual std::string	nameOfActive (size_t i) const
	Returns the name of active parameter i. More...

virtual std::string	descriptionOfActive (size_t i) const
	Returns the name of active parameter i. More...

bool	isActive (size_t i) const
	Check if an active parameter i is actually active. More...

virtual void	tie (const std::string &parName, const std::string &expr, bool isDefault=false)
	Tie a parameter to other parameters (or a constant) More...

virtual void	addTies (const std::string &ties, bool isDefault=false)
	Add several ties. More...

virtual void	applyTies ()
	Apply the ties. More...

virtual void	removeTie (const std::string &parName)
	Removes the tie off a parameter. More...

virtual void	clearTies ()
	Remove all ties. More...

virtual bool	removeTie (size_t i)
	Removes i-th parameter's tie. More...

virtual ParameterTie *	getTie (size_t i) const
	Get the tie of i-th parameter. More...

virtual bool	ignoreTie (const ParameterTie &) const
	Ignore a tie. More...

void	sortTies ()
	Put all ties in order in which they will be applied correctly. More...

std::string	writeTies () const
	Write a parameter tie to a string. More...

virtual void	addConstraints (const std::string &str, bool isDefault=false)
	Add a list of conatraints from a string. More...

virtual void	addConstraint (std::unique_ptr< IConstraint > ic)
	Add a constraint to function. More...

virtual IConstraint *	getConstraint (size_t i) const
	Get constraint of i-th parameter. More...

virtual void	removeConstraint (const std::string &parName)
	Remove a constraint. More...

virtual void	setConstraintPenaltyFactor (const std::string &parName, const double &c)
	Set a constraint penalty. More...

std::string	writeConstraints () const
	Write a parameter constraint to a string. More...

virtual void	clearConstraints ()
	Remove all constraints. More...

virtual std::string	attributeName (size_t index) const
	Get name of ith attribute. More...

template<typename T >
void	setAttributeValue (const std::string &attName, const T &value)
	Set an attribute value. More...

void	setAttributeValue (const std::string &attName, const char *value)
	Overload for const char* values. More...

void	setAttributeValue (const std::string &attName, const std::string &value)
	Set string attribute by value. More...

virtual std::shared_ptr< IFunction >	getFunction (size_t i) const
	Returns the pointer to i-th child function. More...

virtual std::size_t	nFunctions () const
	Number of child functions. More...

virtual void	setUpForFit ()
	Set up the function for a fit. More...

virtual size_t	getValuesSize (const FunctionDomain &domain) const
	Get number of values for a given domain. More...

virtual size_t	getNumberDomains () const
	Get number of domains required by this function. More...

virtual std::vector< std::shared_ptr< IFunction > >	createEquivalentFunctions () const
	Split this function (if needed) into a list of independent functions. More...

void	calNumericalDeriv (const FunctionDomain &domain, Jacobian &jacobian)
	Calculate numerical derivatives. More...

double	calculateStepSize (const double parameterValue) const
	Calculate step size for the given parameter value. More...

void	setCovarianceMatrix (const std::shared_ptr< Kernel::Matrix< double > > &covar)
	Set the covariance matrix. More...

std::shared_ptr< const Kernel::Matrix< double > >	getCovarianceMatrix () const
	Get the covariance matrix. More...

void	setReducedChiSquared (double chi2)
	Set the reduced chi^2. More...

double	getReducedChiSquared () const
	Get the reduced chi^2. More...

void	setParallel (bool on)
	Set the parallel hint. More...

bool	isParallel () const
	Get the parallel hint. More...

void	setHandler (std::unique_ptr< FunctionHandler > handler)
	Set a function handler. More...

FunctionHandler *	getHandler () const
	Return the handler. More...

virtual void	setStepSizeMethod (const StepSizeMethod method)
	Sets the StepSizeMethod to use when calculation the step size. More...

Public Member Functions inherited from Mantid::API::IFunction1D
virtual void	derivative (const FunctionDomain &domain, FunctionValues &values, const size_t order=1) const

virtual void	derivative1D (double out, const double xValues, const size_t nData, const size_t order) const
	Function to calculate the derivatives of the data set. More...

void	function (const FunctionDomain &domain, FunctionValues &values) const override
	Evaluates the function for all arguments in the domain. More...

virtual void	function1D (double out, const double xValues, const size_t nData) const =0
	Function you want to fit to. More...

void	functionDeriv (const FunctionDomain &domain, Jacobian &jacobian) override
	Derivatives of function with respect to active parameters. More...

virtual void	functionDeriv1D (Jacobian jacobian, const double xValues, const size_t nData)
	Derivatives of function with respect to active parameters. More...

Public Member Functions inherited from Mantid::API::IFunctionMW
std::shared_ptr< const API::MatrixWorkspace >	getMatrixWorkspace () const
	Get shared pointer to the workspace. More...

size_t	getWorkspaceIndex () const
	Get the workspace index. More...

void	setMatrixWorkspace (std::shared_ptr< const API::MatrixWorkspace > workspace, size_t wi, double startX, double endX) override
	Set MatrixWorkspace. More...

Public Attributes
bool	CalcVxx

bool	CalcVxy

bool	CalcVyy

Protected Member Functions
void	init () override
	Function initialization. Declare function parameters in this method. More...

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
	common values More...

double	initCommon ()
	Check for changes in parameters, etc. More...

Protected Member Functions inherited from Mantid::API::ParamFunction
void	clearAllParameters ()
	Nonvirtual member which removes all declared parameters. More...

void	declareParameter (const std::string &name, double initValue=0, const std::string &description="") override
	Declare a new parameter. More...

virtual double *	getParameterAddress (size_t i)
	Get the address of the parameter. For use in UserFunction with mu::Parser. More...

ParameterStatus	getParameterStatus (size_t i) const override
	Get status of parameter. More...

void	setParameterStatus (size_t i, ParameterStatus status) override
	Change status of parameter. More...

Protected Member Functions inherited from Mantid::API::IFunction
double	convertValue (double value, Kernel::Unit_sptr &outUnit, const std::shared_ptr< const MatrixWorkspace > &ws, size_t wsIndex) const
	Convert a value from one unit (inUnit) to unit defined in workspace (ws) More...

void	convertValue (std::vector< double > &values, Kernel::Unit_sptr &outUnit, const std::shared_ptr< const MatrixWorkspace > &ws, size_t wsIndex) const
	Convert values from unit defined in workspace (ws) to outUnit. More...

virtual void	declareAttributes ()
	Override to declare function attributes. More...

virtual void	declareParameters ()
	Override to declare function parameters. More...

void	declareAttribute (const std::string &name, const API::IFunction::Attribute &defaultValue)
	Declare a single attribute. More...

void	declareAttribute (const std::string &name, const API::IFunction::Attribute &defaultValue, const Kernel::IValidator &validator)
	Declare a single attribute with validator. More...

void	checkAttributeName (const std::string &name)
	Check Attribute to declare does not already exist. More...

void	storeAttributeValue (const std::string &name, const API::IFunction::Attribute &value)
	Store an attribute's value. More...

void	storeReadOnlyAttribute (const std::string &name, const API::IFunction::Attribute &value) const
	A read-only ("mutable") attribute can be stored in a const method. More...

virtual void	addTie (std::unique_ptr< ParameterTie > tie)
	Add a new tie. Derived classes must provide storage for ties. More...

bool	hasOrderedTies () const

void	applyOrderedTies ()

virtual std::string	writeToString (const std::string &parentLocalAttributesStr="") const
	Writes itself into a string. More...

Protected Member Functions inherited from Mantid::API::IFunction1D
template<typename EvaluationMethod >
void	calcNumericalDerivative1D (Jacobian jacobian, EvaluationMethod func1D, const double xValues, const size_t nData)
	Calculate a numerical derivative for the 1D data. More...

virtual void	histogram1D (double out, double left, const double right, const size_t nBins) const
	Calculate histogram data for the given bin boundaries. More...

virtual void	histogramDerivative1D (Jacobian jacobian, double left, const double right, const size_t nBins) const
	Derivatives of the histogram1D with respect to active parameters. More...

Protected Attributes
bool	CalcVariances
	from experimental data versus fit the (Co)Variances More...

double	coefNorm

double	expCoeffx2

double	expCoeffxy

double	expCoeffy2

double *	expVals
	Save common exponential values for each cell. More...

double	LastParams [9]
	Saves previous/this set of parameters. More...

double	mIx

double	mIy

double	mx

double	my

int	NCells

double	SIxx

double	SIxy

double	SIyy

double	Sxx

double	Sxy

double	Syy

double	TotI

double	TotN

double	uu

double	Varx0

double	Vary0

Protected Attributes inherited from Mantid::API::IFunction
bool	m_isParallel
	Flag to hint that the function is being used in parallel computations. More...

std::unique_ptr< FunctionHandler >	m_handler
	Pointer to a function handler. More...

std::shared_ptr< Kernel::ProgressBase >	m_progReporter
	Pointer to the progress handler. More...

Protected Attributes inherited from Mantid::API::IFunctionMW
std::weak_ptr< const API::MatrixWorkspace >	m_workspace
	Keep a weak pointer to the workspace. More...

size_t	m_workspaceIndex
	An index to a spectrum. More...

Additional Inherited Members
Public Types inherited from Mantid::API::IFunction
enum	ParameterStatus { Active , Fixed , FixedByDefault , Tied }
	Describe parameter status in relation to fitting: Active: Fit varies such parameter directly. More...

enum class	StepSizeMethod { DEFAULT , SQRT_EPSILON }
	Describes the method in which the step size will be calculated: DEFAULT: Uses the traditional Mantid method of calculating the step size. More...

Protected Types inherited from Mantid::API::IFunction1D
template<typename FunctionType >
using	Function1DMethod = void(FunctionType::)(double , const double *, const size_t) const

Static Protected Attributes inherited from Mantid::API::IFunction1D
static Kernel::Logger	g_log
	Logger instance. More...

Detailed Description

Provide peak shape function interface a Peak shape on one time slice of a RectangularDetector.

i.e. the function: Background +Intensity* NormalDist( col,row,col_mean,row_mean,col_sigma,row_sigma, covariance)

Where NormalDist is the bivariate normal distribution whose total "area" is

So Intensity should be the integrated intensity.

BivariateNormal parameters:

Background - The background of the peak
Intensity - The intensity of data for the peak on this time slice
Mcol - The col of the center of the peak
Mrow - The row of the center of the peak on this slice
SScol -The variance of the column values in the peak for this time slice
SSrow - The variance of the row values in the peak for this time slice
SSrc - The covariance of the row and column values in the peak for this time slice

There is one attribute, This must be specified.

CalcVariances - If true,calculates SScol, SSrow, and SSrc from the experimental data given Background, Mcol, and Mrow,if the parameter has not been tied, If false, the parameters SScol, SSrow, and SSrc will be fit, unless tied.

This is a bivariate function. The workspace must have three histograms of equal length. Histogram 0: Contains the experimental values for each x and y, along with their errors. Histogram 1: Contains the corresponding x value for the data in Histogram 0 Histogram 2: contains the corresponding y values for the data in Histogram 0

Author: Ruth Mikkelson, SNS ORNL

Date: 11/4/2011

Definition at line 71 of file BivariateNormal.h.

Constructor & Destructor Documentation

◆ BivariateNormal()

Mantid::CurveFitting::Functions::BivariateNormal::BivariateNormal ( )

Definition at line 65 of file BivariateNormal.cpp.

References IVXX, LastParams, and Varx0.

◆ ~BivariateNormal()

Mantid::CurveFitting::Functions::BivariateNormal::~BivariateNormal ( )

override

Destructor.

Definition at line 74 of file BivariateNormal.cpp.

References expVals.

Member Function Documentation

◆ category()

const std::string Mantid::CurveFitting::Functions::BivariateNormal::category ( ) const

inlineoverridevirtual

The categories the Fit function belong to.

Categories must be listed as a semi colon separated list. For example: "General, Muon\\Custom" which adds a function to the category "General" and the sub-category "Muon\\Custom"

Reimplemented from Mantid::API::IFunction.

Definition at line 82 of file BivariateNormal.h.

◆ function1D()

void Mantid::CurveFitting::Functions::BivariateNormal::function1D	(	double *	out,
		const double *	xValues,
		const size_t	nData
	)		const

overridevirtual

Function you want to fit to.

Implements Mantid::API::IFunction1D.

Definition at line 78 of file BivariateNormal.cpp.

References Mantid::API::IConstraint::check(), coefNorm, Mantid::Kernel::Logger::debug(), expCoeffx2, expCoeffxy, expCoeffy2, Mantid::API::IFunction1D::g_log, Mantid::API::IFunction::getConstraint(), Mantid::API::IFunctionMW::getMatrixWorkspace(), Mantid::API::ParamFunction::getParameter(), IBACK, initCoeff(), ITINTENS, IXMEAN, IYMEAN, NCells, Mantid::API::ParamFunction::nParams(), Mantid::API::IConstraint::setPenaltyFactor(), UNUSED_ARG, Varx0, Mantid::Geometry::X, Mantid::Geometry::x, and Mantid::Geometry::Y.

Referenced by functionDeriv1D().

◆ functionDeriv1D()

void Mantid::CurveFitting::Functions::BivariateNormal::functionDeriv1D	(	API::Jacobian *	jacobian,
		const double *	xValues,
		const size_t	nData
	)

overridevirtual

Derivatives of function with respect to active parameters.

Reimplemented from Mantid::API::IFunction1D.

Definition at line 163 of file BivariateNormal.cpp.

References CalcVariances, CalcVxx, CalcVxy, CalcVyy, coefNorm, Mantid::Kernel::Logger::debug(), expVals, function1D(), Mantid::API::IFunction1D::g_log, Mantid::API::Jacobian::get(), Mantid::API::IFunctionMW::getMatrixWorkspace(), IBACK, initCommon(), ITINTENS, IVXX, IVXY, IVYY, IXMEAN, IYMEAN, LastParams, mIx, mIy, mx, my, NCells, Mantid::API::ParamFunction::nParams(), Mantid::API::Jacobian::set(), Sxx, Sxy, Syy, TotI, TotN, UNUSED_ARG, uu, Varx0, Vary0, Mantid::Geometry::X, Mantid::Geometry::x, and Mantid::Geometry::Y.

◆ getAttribute()

Attribute Mantid::CurveFitting::Functions::BivariateNormal::getAttribute ( const std::string & name ) const

inlineoverridevirtual

Return a value of attribute attName.

Parameters

name	:: Returns the named attribute

Reimplemented from Mantid::API::IFunction.

Definition at line 96 of file BivariateNormal.h.

◆ getAttributeNames()

std::vector< std::string > Mantid::CurveFitting::Functions::BivariateNormal::getAttributeNames ( ) const

inlineoverridevirtual

Returns a list of attribute names.

Reimplemented from Mantid::API::IFunction.

Definition at line 90 of file BivariateNormal.h.

◆ hasAttribute()

bool Mantid::CurveFitting::Functions::BivariateNormal::hasAttribute ( const std::string & name ) const

inlineoverridevirtual

Check if attribute attName exists.

Check if attribute named exists.

Reimplemented from Mantid::API::IFunction.

Definition at line 123 of file BivariateNormal.h.

◆ init()

void Mantid::CurveFitting::Functions::BivariateNormal::init ( )

overrideprotectedvirtual

Function initialization. Declare function parameters in this method.

Initialize the function. Calls declareAttributes & declareParameters.

Reimplemented from Mantid::API::IFunction.

Definition at line 369 of file BivariateNormal.cpp.

References CalcVariances, Mantid::API::ParamFunction::declareParameter(), IVXX, LastParams, and NCells.

◆ initCoeff()

double Mantid::CurveFitting::Functions::BivariateNormal::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

protected

common values

Definition at line 562 of file BivariateNormal.cpp.

References CalcVxx, CalcVxy, CalcVyy, coefNorm, expCoeffx2, expCoeffxy, expCoeffy2, fabs, Mantid::API::ParamFunction::getParameter(), IVXX, IVXY, IVYY, mIx, mIy, mx, my, NCells, Mantid::API::ParamFunction::nParams(), SIxx, SIxy, SIyy, Sxx, Sxy, Syy, TotI, TotN, uu, Varx0, Vary0, Mantid::Geometry::X, and Mantid::Geometry::Y.

Referenced by function1D(), and initCommon().

◆ initCommon()

double Mantid::CurveFitting::Functions::BivariateNormal::initCommon ( )

protected

Check for changes in parameters, etc.

Calculates

Definition at line 381 of file BivariateNormal.cpp.

References Mantid::API::IFunction::addConstraint(), CalcVariances, CalcVxx, CalcVxy, CalcVyy, coefNorm, expCoeffx2, expCoeffxy, expCoeffy2, expVals, Mantid::API::IFunction::getConstraint(), Mantid::API::IFunctionMW::getMatrixWorkspace(), Mantid::API::ParamFunction::getParameter(), Mantid::API::IFunction::getTie(), initCoeff(), IVXX, IVXY, IVYY, IXMEAN, IYMEAN, LastParams, mIx, mIy, mx, my, NCells, Mantid::API::ParamFunction::nParams(), S_1, S_int, S_x, S_x2, S_x2int, S_xint, S_xy, S_xyint, S_y, S_y2, S_y2int, S_yint, SIxx, SIxy, SIyy, Sxx, Sxy, Syy, Mantid::API::IFunction::tie(), TotI, TotN, Varx0, Vary0, Mantid::Geometry::X, and Mantid::Geometry::Y.

Referenced by functionDeriv1D().

◆ name()

std::string Mantid::CurveFitting::Functions::BivariateNormal::name ( ) const

inlineoverridevirtual

overwrite IFunction base class methods

Implements Mantid::API::IFunction.

Definition at line 80 of file BivariateNormal.h.

◆ nAttributes()

size_t Mantid::CurveFitting::Functions::BivariateNormal::nAttributes ( ) const

inlineoverridevirtual

Returns the number of attributes associated with the function.

Reimplemented from Mantid::API::IFunction.

Definition at line 88 of file BivariateNormal.h.

◆ setAttribute()

void Mantid::CurveFitting::Functions::BivariateNormal::setAttribute	(	const std::string &	name,
		const Attribute &	value
	)

inlineoverridevirtual

Set a value to attribute attName.

Set a value to a named attribute.

Can be overridden in the inheriting class, the default just stores the value

Parameters

name	:: The name of the attribute
value	:: The value of the attribute

Reimplemented from Mantid::API::IFunction.

Definition at line 106 of file BivariateNormal.h.

References value.

Member Data Documentation

◆ CalcVariances

bool Mantid::CurveFitting::Functions::BivariateNormal::CalcVariances

protected

from experimental data versus fit the (Co)Variances

Definition at line 132 of file BivariateNormal.h.

Referenced by functionDeriv1D(), init(), and initCommon().

◆ CalcVxx

bool Mantid::CurveFitting::Functions::BivariateNormal::CalcVxx

Definition at line 125 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ CalcVxy

bool Mantid::CurveFitting::Functions::BivariateNormal::CalcVxy

Definition at line 125 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ CalcVyy

bool Mantid::CurveFitting::Functions::BivariateNormal::CalcVyy

Definition at line 125 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ coefNorm

double Mantid::CurveFitting::Functions::BivariateNormal::coefNorm

protected

Definition at line 153 of file BivariateNormal.h.

Referenced by function1D(), functionDeriv1D(), initCoeff(), and initCommon().

◆ expCoeffx2

double Mantid::CurveFitting::Functions::BivariateNormal::expCoeffx2

protected

Definition at line 153 of file BivariateNormal.h.

Referenced by function1D(), initCoeff(), and initCommon().

◆ expCoeffxy

double Mantid::CurveFitting::Functions::BivariateNormal::expCoeffxy

protected

Definition at line 154 of file BivariateNormal.h.

Referenced by function1D(), initCoeff(), and initCommon().

◆ expCoeffy2

double Mantid::CurveFitting::Functions::BivariateNormal::expCoeffy2

protected

Definition at line 153 of file BivariateNormal.h.

Referenced by function1D(), initCoeff(), and initCommon().

◆ expVals

double* Mantid::CurveFitting::Functions::BivariateNormal::expVals

protected

Save common exponential values for each cell.

Definition at line 151 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCommon(), and ~BivariateNormal().

◆ LastParams

double Mantid::CurveFitting::Functions::BivariateNormal::LastParams[9]

protected

Saves previous/this set of parameters.

Definition at line 149 of file BivariateNormal.h.

Referenced by BivariateNormal(), functionDeriv1D(), init(), and initCommon().

◆ mIx

double Mantid::CurveFitting::Functions::BivariateNormal::mIx

protected

Definition at line 142 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ mIy

double Mantid::CurveFitting::Functions::BivariateNormal::mIy

protected

Definition at line 142 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ mx

double Mantid::CurveFitting::Functions::BivariateNormal::mx

protected

Definition at line 142 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ my

double Mantid::CurveFitting::Functions::BivariateNormal::my

protected

Definition at line 142 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ NCells

int Mantid::CurveFitting::Functions::BivariateNormal::NCells

protected

Definition at line 130 of file BivariateNormal.h.

Referenced by function1D(), functionDeriv1D(), init(), initCoeff(), and initCommon().

◆ SIxx

double Mantid::CurveFitting::Functions::BivariateNormal::SIxx

protected

Definition at line 143 of file BivariateNormal.h.

Referenced by initCoeff(), and initCommon().

◆ SIxy

double Mantid::CurveFitting::Functions::BivariateNormal::SIxy

protected

Definition at line 143 of file BivariateNormal.h.

Referenced by initCoeff(), and initCommon().

◆ SIyy

double Mantid::CurveFitting::Functions::BivariateNormal::SIyy

protected

Definition at line 143 of file BivariateNormal.h.

Referenced by initCoeff(), and initCommon().

◆ Sxx

double Mantid::CurveFitting::Functions::BivariateNormal::Sxx

protected

Definition at line 143 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ Sxy

double Mantid::CurveFitting::Functions::BivariateNormal::Sxy

protected

Definition at line 143 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ Syy

double Mantid::CurveFitting::Functions::BivariateNormal::Syy

protected

Definition at line 143 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ TotI

double Mantid::CurveFitting::Functions::BivariateNormal::TotI

protected

Definition at line 144 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ TotN

double Mantid::CurveFitting::Functions::BivariateNormal::TotN

protected

Definition at line 144 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

◆ uu

double Mantid::CurveFitting::Functions::BivariateNormal::uu

protected

Definition at line 153 of file BivariateNormal.h.

Referenced by functionDeriv1D(), and initCoeff().

◆ Varx0

double Mantid::CurveFitting::Functions::BivariateNormal::Varx0

protected

Definition at line 146 of file BivariateNormal.h.

Referenced by BivariateNormal(), function1D(), functionDeriv1D(), initCoeff(), and initCommon().

◆ Vary0

double Mantid::CurveFitting::Functions::BivariateNormal::Vary0

protected

Definition at line 146 of file BivariateNormal.h.

Referenced by functionDeriv1D(), initCoeff(), and initCommon().

The documentation for this class was generated from the following files:

Framework/CurveFitting/inc/MantidCurveFitting/Functions/BivariateNormal.h
Framework/CurveFitting/src/Functions/BivariateNormal.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BivariateNormal()

◆ ~BivariateNormal()

Member Function Documentation

◆ category()

◆ function1D()

◆ functionDeriv1D()

◆ getAttribute()

◆ getAttributeNames()

◆ hasAttribute()

◆ init()

◆ initCoeff()

◆ initCommon()

◆ name()

◆ nAttributes()

◆ setAttribute()

Member Data Documentation

◆ CalcVariances

◆ CalcVxx

◆ CalcVxy

◆ CalcVyy

◆ coefNorm

◆ expCoeffx2

◆ expCoeffxy

◆ expCoeffy2

◆ expVals

◆ LastParams

◆ mIx

◆ mIy

◆ mx

◆ my

◆ NCells

◆ SIxx

◆ SIxy

◆ SIyy

◆ Sxx

◆ Sxy

◆ Syy

◆ TotI

◆ TotN

◆ uu

◆ Varx0

◆ Vary0