Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
MantidQt::MantidWidgets::MuonFunctionBrowser Class Reference

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

#include <MuonFunctionBrowser.h>

Inheritance diagram for MantidQt::MantidWidgets::MuonFunctionBrowser:
MantidQt::MantidWidgets::FunctionBrowser MantidQt::MantidWidgets::IFunctionBrowser

Public Member Functions

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

Additional Inherited Members

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