A wrapper around Eigen functions implementing a B-spline. More...

#include <BSpline.h>

Inheritance diagram for Mantid::CurveFitting::Functions::BSpline:

Public Member Functions
	BSpline ()
	Constructor. More...

std::vector< double >	calcUniformBreakPoints (const double startX, const double endX)
	Populate a vector with a uniform set of break points. More...

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

void	derivative1D (double out, const double xValues, size_t nData, const size_t order) const override
	Calculate the derivatives for a set of points on the spline. More...

EigenMatrix	evaluateBasisFnDerivatives (const double x, const size_t derivOrder) const
	Evaluate derivatives up to a specified order for each non-zero basis function. More...

size_t	evaluateBasisFunctions (EigenVector &B, const double x, size_t currentBBase) const
	evaluate non-zero basis functions, return which index to use as the base of the results vector. More...

void	function1D (double out, const double xValues, const size_t nData) const override
	Execute the function. More...

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

int	getClampedKnots () const
	Get number of knots required to clamp the spline closed. More...

int	getDegree () const
	Get the degree of constituent polynomial functions. More...

int	getNBreakPoints () const
	Get number of Break Points. More...

int	getNBSplineCoefficients ()
	Get number of B-Spline coefficients. More...

int	getNKnots () const
	Get number of Knots. More...

int	getOrder () const
	Get order of the spline, k. More...

size_t	getSpanIndex (const double x, const size_t currentBBase, const bool clamped=true) const
	get the index of the span/interval which x is in More...

void	initialiseSpline (const std::vector< double > &breakPoints)
	initialise the m_spline variable based on the knot vector and given a vector of breakpoints More...

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

void	resetKnots ()
	Reset b-spline knots. More...

void	resetKnotVector (const std::vector< double > &breakPoints)
	Reset knot vector based upon break points. More...

void	resetParameters ()
	Reset fitting parameters. More...

void	resetValidators ()
	Reset Function Attribute Validators. More...

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

Public Member Functions inherited from Mantid::CurveFitting::Functions::BackgroundFunction
const std::string	category () const override
	overwrite IFunction base class methods More...

double	centre () const override
	Returns the centre of the function, which may be something as simple as the centre of the fitting range in the case of a background function or peak shape function this return value reflects the centre of the peak. More...

void	fit (const std::vector< double > &X, const std::vector< double > &Y) override
	Fits the function. More...

double	height () const override
	Returns the height of the function. More...

void	setCentre (const double c) override
	Sets the parameters such that centre == c. More...

void	setHeight (const double h) override
	Sets the parameters such that height == h. More...

virtual void	fit (const std::vector< double > &X, const std::vector< double > &Y)=0
	Fits the function. More...

Public Member Functions inherited from Mantid::API::IFunctionWithLocation
virtual double	centre () const =0
	Returns the centre of the function, which may be something as simple as the centre of the fitting range in the case of a background function or peak shape function this return value reflects the centre of the peak. More...

virtual void	fixCentre (bool isDefault=false)
	Fix a parameter or set up a tie such that value returned by centre() is constant during fitting. More...

virtual double	height () const =0
	Returns the height of the function. More...

virtual void	setCentre (const double c)=0
	Sets the parameters such that centre == c. More...

virtual void	setHeight (const double h)=0
	Sets the parameters such that height == h. More...

virtual void	unfixCentre ()
	Free the centre parameter. More...

	~IFunctionWithLocation () override=default
	Virtual destructor (avoids warnings about non-trivial move assignment in virtually inheriting classes) 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 size_t	nAttributes () const
	Returns the number of attributes associated with the function. More...

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

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

virtual bool	hasAttribute (const std::string &name) const
	Check if attribute attName exists. 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 Attributes
std::vector< double >	m_knots

Spline1D	m_spline
	Member variable for spline. 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

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
virtual void	init ()
	Function initialization. Declare function parameters in this method. More...

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 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...

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

Detailed Description

A wrapper around Eigen functions implementing a B-spline.

This function can also calculate basis function derivatives.

Definition at line 28 of file BSpline.h.

Constructor & Destructor Documentation

◆ BSpline()

Mantid::CurveFitting::Functions::BSpline::BSpline ( )

Constructor.

Definition at line 28 of file BSpline.cpp.

Member Function Documentation

◆ calcUniformBreakPoints()

std::vector< double > Mantid::CurveFitting::Functions::BSpline::calcUniformBreakPoints	(	const double	startX,
		const double	endX
	)

Populate a vector with a uniform set of break points.

Populate a provided vector with a set of uniform break points.

Parameters

startX	:: A double representing the first x value of the range
endX	:: A double representing the first last x value of the range

Returns: :: a vector with a set of uniform break points

Definition at line 284 of file BSpline.cpp.

References getNBreakPoints(), and n.

Referenced by resetKnots().

◆ category()

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

inlineoverridevirtual

overwrite IFunction base class methods

Reimplemented from Mantid::CurveFitting::Functions::BackgroundFunction.

Definition at line 34 of file BSpline.h.

◆ derivative1D()

void Mantid::CurveFitting::Functions::BSpline::derivative1D	(	double *	out,
		const double *	xValues,
		size_t	nData,
		const size_t	order
	)		const

overridevirtual

Calculate the derivatives for a set of points on the spline.

Parameters

out	:: The array to store the derivatives in
xValues	:: The array of x values we wish to know the derivatives of
nData	:: The size of the arrays
order	:: The order of the derivatives to calculate

Reimplemented from Mantid::API::IFunction1D.

Definition at line 160 of file BSpline.cpp.

References Mantid::API::IFunction::Attribute::asDouble(), Mantid::API::IFunction::Attribute::asInt(), evaluateBasisFnDerivatives(), Mantid::API::IFunction::getAttribute(), Mantid::API::ParamFunction::getParameter(), getSpanIndex(), and Mantid::Geometry::x.

◆ evaluateBasisFnDerivatives()

EigenMatrix Mantid::CurveFitting::Functions::BSpline::evaluateBasisFnDerivatives	(	const double	x,
		const size_t	derivOrder
	)		const

Evaluate derivatives up to a specified order for each non-zero basis function.

Calculate the derivatives of the basis functions for a specific point on the spline.

Parameters

x	:: A point on the spline
derivOrder	:: The order of the derivatives to calculate

Returns: :: An eigen matrix comprising of the derivatives for each basis function.

Definition at line 190 of file BSpline.cpp.

References getDegree(), m_spline, Mantid::CurveFitting::EigenMatrix::mutator(), and Mantid::Geometry::x.

Referenced by derivative1D().

◆ evaluateBasisFunctions()

size_t Mantid::CurveFitting::Functions::BSpline::evaluateBasisFunctions	(	EigenVector &	B,
		const double	x,
		size_t	currentBBase
	)		const

evaluate non-zero basis functions, return which index to use as the base of the results vector.

Evaluate the basis functions that make up the spline at point x.

Parameters

B	:: The EigenVector to store the results in
x	:: Position at which to evaluate the basis functions
currentBBase	:: The last return value from this function

Returns: :: The index to use as the base in the results vector. This corresponds to the index of the first basis vector being evaluated at point x, along the entire spline.

Definition at line 121 of file BSpline.cpp.

References getDegree(), getSpanIndex(), m_spline, Mantid::Geometry::x, and Mantid::CurveFitting::EigenVector::zero().

Referenced by function1D().

◆ function1D()

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

overridevirtual

Execute the function.

Parameters

out	:: The array to store the calculated y values
xValues	:: The array of x values to interpolate
nData	:: The size of the arrays

Implements Mantid::API::IFunction1D.

Definition at line 82 of file BSpline.cpp.

References Mantid::API::IFunction::Attribute::asDouble(), evaluateBasisFunctions(), Mantid::CurveFitting::EigenVector::get(), Mantid::API::IFunction::getAttribute(), Mantid::API::ParamFunction::getParameter(), Mantid::API::ParamFunction::nParams(), and Mantid::Geometry::x.

◆ getAttributeNames()

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

overridevirtual

Returns a list of attribute names.

Returns: Names of all declared attributes in correct order.

Reimplemented from Mantid::API::IFunction.

Definition at line 222 of file BSpline.cpp.

◆ getClampedKnots()

int Mantid::CurveFitting::Functions::BSpline::getClampedKnots ( ) const

inline

Get number of knots required to clamp the spline closed.

Definition at line 71 of file BSpline.h.

Referenced by getSpanIndex(), and resetKnotVector().

◆ getDegree()

int Mantid::CurveFitting::Functions::BSpline::getDegree ( ) const

inline

Get the degree of constituent polynomial functions.

Definition at line 73 of file BSpline.h.

Referenced by evaluateBasisFnDerivatives(), and evaluateBasisFunctions().

◆ getNBreakPoints()

int Mantid::CurveFitting::Functions::BSpline::getNBreakPoints ( ) const

inline

Get number of Break Points.

Definition at line 65 of file BSpline.h.

Referenced by calcUniformBreakPoints(), and resetKnots().

◆ getNBSplineCoefficients()

int Mantid::CurveFitting::Functions::BSpline::getNBSplineCoefficients ( )

inline

Get number of B-Spline coefficients.

Definition at line 63 of file BSpline.h.

Referenced by resetParameters().

◆ getNKnots()

int Mantid::CurveFitting::Functions::BSpline::getNKnots ( ) const

inline

Get number of Knots.

Definition at line 67 of file BSpline.h.

Referenced by resetKnotVector().

◆ getOrder()

int Mantid::CurveFitting::Functions::BSpline::getOrder ( ) const

inline

Get order of the spline, k.

Definition at line 69 of file BSpline.h.

◆ getSpanIndex()

size_t Mantid::CurveFitting::Functions::BSpline::getSpanIndex	(	const double	x,
		const size_t	currentBBase,
		const bool	clamped = `true`
	)		const

get the index of the span/interval which x is in

Return the span to which point x corresponds.

Parameters

x	:: a position along the spline
currentBBase	:: The last return value from this function (for looping efficiency, given x will always be in accending order)
clamped	:: if the spline is to be clamped or not (BSpline only currently supports clamped).

Returns: :: The index of the span to which point x corresponds, base 0, not including spans between the clamped knots.

Definition at line 142 of file BSpline.cpp.

References getClampedKnots(), m_knots, and Mantid::Geometry::x.

Referenced by derivative1D(), and evaluateBasisFunctions().

◆ initialiseSpline()

void Mantid::CurveFitting::Functions::BSpline::initialiseSpline ( const std::vector< double > & breakPoints )

initialise the m_spline variable based on the knot vector and given a vector of breakpoints

Initialise the spline member variable.

Parameters

breakPoints :: Vector of breakpoints to be passed as control points

Definition at line 109 of file BSpline.cpp.

References m_knots, and m_spline.

Referenced by resetKnots().

◆ name()

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

inlineoverridevirtual

overwrite IFunction base class methods

Implements Mantid::API::IFunction.

Definition at line 33 of file BSpline.h.

◆ resetKnots()

void Mantid::CurveFitting::Functions::BSpline::resetKnots ( )

Reset b-spline knots.

Recalculate the B-spline knots and initialise spline variable.

Definition at line 243 of file BSpline.cpp.

References Mantid::API::IFunction::Attribute::asBool(), Mantid::API::IFunction::Attribute::asDouble(), Mantid::API::IFunction::Attribute::asVector(), calcUniformBreakPoints(), Mantid::API::IFunction::getAttribute(), getNBreakPoints(), initialiseSpline(), resetKnotVector(), resetParameters(), and Mantid::API::IFunction::storeAttributeValue().

Referenced by setAttribute().

◆ resetKnotVector()

void Mantid::CurveFitting::Functions::BSpline::resetKnotVector ( const std::vector< double > & breakPoints )

Reset knot vector based upon break points.

Reset knot vector given a vector of break points.

Parameters

breakPoints :: A vector of breakpoints

Definition at line 297 of file BSpline.cpp.

References getClampedKnots(), getNKnots(), and m_knots.

Referenced by resetKnots().

◆ resetParameters()

void Mantid::CurveFitting::Functions::BSpline::resetParameters ( )

Reset fitting parameters.

Reset fitting parameters after changes to some attributes.

Definition at line 229 of file BSpline.cpp.

References Mantid::API::ParamFunction::clearAllParameters(), Mantid::API::ParamFunction::declareParameter(), getNBSplineCoefficients(), Mantid::API::ParamFunction::nParams(), and std::to_string().

Referenced by resetKnots(), and setAttribute().

◆ resetValidators()

void Mantid::CurveFitting::Functions::BSpline::resetValidators ( )

Reset Function Attribute Validators.

Definition at line 60 of file BSpline.cpp.

References Mantid::API::IFunction::getAttribute(), Mantid::API::IFunction::Attribute::getValidator(), Mantid::Kernel::ArrayBoundedValidator< TYPE >::setLower(), Mantid::Kernel::BoundedValidator< TYPE >::setLower(), and Mantid::Kernel::BoundedValidator< TYPE >::setUpper().

Referenced by setAttribute().

◆ setAttribute()

void Mantid::CurveFitting::Functions::BSpline::setAttribute	(	const std::string &	attName,
		const Attribute &	att
	)

overridevirtual

Set a value to attribute attName.

Set an attribute for the function.

Parameters

attName	:: The name of the attribute to set
att	:: The attribute to set

Reimplemented from Mantid::API::IFunction.

Definition at line 202 of file BSpline.cpp.

References Mantid::API::IFunction::Attribute::asBool(), Mantid::API::IFunction::Attribute::asVector(), resetKnots(), resetParameters(), resetValidators(), and Mantid::API::IFunction::storeAttributeValue().

Member Data Documentation

◆ m_knots

std::vector<double> Mantid::CurveFitting::Functions::BSpline::m_knots

Definition at line 77 of file BSpline.h.

Referenced by getSpanIndex(), initialiseSpline(), and resetKnotVector().

◆ m_spline

Spline1D Mantid::CurveFitting::Functions::BSpline::m_spline

Member variable for spline.

Definition at line 76 of file BSpline.h.

Referenced by evaluateBasisFnDerivatives(), evaluateBasisFunctions(), and initialiseSpline().

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

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BSpline()

Member Function Documentation

◆ calcUniformBreakPoints()

◆ category()

◆ derivative1D()

◆ evaluateBasisFnDerivatives()

◆ evaluateBasisFunctions()

◆ function1D()

◆ getAttributeNames()

◆ getClampedKnots()

◆ getDegree()

◆ getNBreakPoints()

◆ getNBSplineCoefficients()

◆ getNKnots()

◆ getOrder()

◆ getSpanIndex()

◆ initialiseSpline()

◆ name()

◆ resetKnots()

◆ resetKnotVector()

◆ resetParameters()

◆ resetValidators()

◆ setAttribute()

Member Data Documentation

◆ m_knots

◆ m_spline