MantidQt::MantidWidgets::MuonFunctionBrowser Class Reference

MuonFunctionBrowser : Subclasses FunctionBrowser for muon-specific use. More...

#include <MuonFunctionBrowser.h>

Inheritance diagram for MantidQt::MantidWidgets::MuonFunctionBrowser:

Public Member Functions
	MuonFunctionBrowser (QWidget *parent=nullptr, bool multi=false)
	Constructor.
virtual	~MuonFunctionBrowser () override
	Destructor.
Public Member Functions inherited from MantidQt::MantidWidgets::FunctionBrowser
void	clear () override
	Clear the contents.
void	clearErrors () override
	Clear all errors.
std::optional< std::string >	currentFunctionIndex ()
	Return index of the current function, if one is selected.
	FunctionBrowser (QWidget *parent=nullptr, bool multi=false, const std::vector< std::string > &categories=std::vector< std::string >())
	Constructor.
int	getCurrentDataset () const override
	Get the index of the current dataset.
std::vector< std::string >	getDatasetDomainNames () const override
	Get the names of the dataset domains.
std::vector< std::string >	getDatasetNames () const override
	Get the names of datasets.
std::string	getFitFunctionString () const
IFunction_sptr	getFunction ()
	Return the function.
IFunction_sptr	getFunctionByIndex (std::string const &index)
	Return a function with specified index.
std::string	getFunctionString () override
	Return FunctionFactory function string.
IFunction_sptr	getGlobalFunction () override
	Return the multidomain function if number of datasets is greater than 1.
std::vector< std::string >	getGlobalParameters () const
	Get a list of names of global parameters.
double	getLocalParameterError (std::string const &parameterName, int i) const
	Get error of a local parameter.
std::vector< std::string >	getLocalParameters () const
	Get a list of names of local parameters.
std::string	getLocalParameterTie (std::string const &parameterName, int i) const override
	Get the tie for a local parameter.
double	getLocalParameterValue (std::string const &parameterName, int i) const override
	Get value of a local parameter.
int	getNumberOfDatasets () const override
	Get the number of datasets.
double	getParameter (std::string const &parameterName) const
	Get a value of a parameter.
bool	hasFunction () const
	Check if a function is set.
void	hideGlobalCheckbox ()
bool	isLocalParameterFixed (std::string const &parameterName, int i) const override
	Check if a local parameter is fixed.
void	setBackgroundA0 (double value)
	Set a parameter that is responsible for the background level.
void	setColumnSizes (int s0, int s1, int s2=-1)
	Resize the browser's columns.
void	setErrorsEnabled (bool enabled) override
	Set error display on/off.
void	setFunction (IFunction_sptr fun)
	Set the function in the browser.
void	setFunction (std::string const &funStr) override
	Set the function in the browser.
void	setGlobalParameters (std::vector< std::string > const &globals)
void	setLocalParameterFixed (std::string const &parameterName, int i, bool fixed) override
	Fix/unfix local parameter.
void	setLocalParameterTie (std::string const &parameterName, int i, std::string const &tie) override
	Set a tie for a local parameter.
void	setLocalParameterValue (std::string const &parameterName, int i, double value) override
	Set value of a local parameter.
void	setLocalParameterValue (std::string const &parameterName, int i, double value, double error)
	Set value and error of a local parameter.
void	setParameter (std::string const &parameterName, double value)
	Update the function parameter value.
void	setParameterError (std::string const &parameterName, double error)
	Update the function parameter error.
void	setStretchLastColumn (bool stretch)
	Set the last column to stretch.
void	showGlobalCheckbox ()
void	updateMultiDatasetAttributes (const IFunction &fun)
	Update parameter values in the browser to match those of a function.
void	updateMultiDatasetParameters (const IFunction &fun) override
	Update parameter values in the browser to match those of a function.
void	updateMultiDatasetParameters (const ITableWorkspace &paramTable) override
	Update parameter values in the browser to match those in a table workspace.
void	updateParameters (const IFunction &fun) override
	Update parameter values in the browser to match those of a function.
FunctionTreeView *	view () const
virtual	~FunctionBrowser () override
	Destructor.
Public Member Functions inherited from MantidQt::MantidWidgets::IFunctionBrowser
virtual void	setCurrentDataset (int i)=0
virtual void	setDatasets (const QList< FunctionModelDataset > &datasets)=0
virtual void	setDatasets (const std::vector< std::string > &datasetNames)=0
virtual void	setNumberOfDatasets (int n)=0
virtual	~IFunctionBrowser ()=default

Additional Inherited Members
Public Slots inherited from MantidQt::MantidWidgets::FunctionBrowser
void	addDatasets (const std::vector< std::string > &names)
	Add some datasets to those already set.
void	removeDatasets (const QList< int > &indices)
	Remove local parameter values for a number of datasets.
void	resetLocalParameters ()
void	setCurrentDataset (int i) override
	Set current dataset.
void	setDatasets (const QList< FunctionModelDataset > &datasets) override
	Sets the datasets being fitted.
void	setDatasets (const std::vector< std::string > &datasetNames) override
	Sets the datasets being fitted.
void	setNumberOfDatasets (int n) override
	Set new number of the datasets.
Signals inherited from MantidQt::MantidWidgets::FunctionBrowser
void	attributeChanged (std::string const &attributeName)
void	currentFunctionChanged ()
	User selects a different function (or one of it's sub-properties)
void	functionStructureChanged ()
void	globalsChanged ()
void	localParameterButtonClicked (std::string const &parName)
	In multi-dataset context a button value editor was clicked.
void	parameterChanged (std::string const &funcIndex, std::string const &paramName)
Protected Attributes inherited from MantidQt::MantidWidgets::FunctionBrowser
std::unique_ptr< FunctionMultiDomainPresenter >	m_presenter

Detailed Description

MuonFunctionBrowser : Subclasses FunctionBrowser for muon-specific use.

Definition at line 17 of file MuonFunctionBrowser.h.

Constructor & Destructor Documentation

MuonFunctionBrowser()

MantidQt::MantidWidgets::MuonFunctionBrowser::MuonFunctionBrowser	(	QWidget *	parent = nullptr,
		bool	multi = false
	)

Constructor.

Parameters

parent	:: The parent widget.
multi	:: Option to use the browser for multi-dataset fitting.

Definition at line 18 of file MuonFunctionBrowser.cpp.

~MuonFunctionBrowser()

virtual MantidQt::MantidWidgets::MuonFunctionBrowser::~MuonFunctionBrowser ( )

overridevirtual

Destructor.

---

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

• qt/widgets/common/inc/MantidQtWidgets/Common/MuonFunctionBrowser.h
• qt/widgets/common/src/MuonFunctionBrowser.cpp