FunctionBrowser.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 "DllOption.h"
 
#include "MantidAPI/IFunction.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidQtWidgets/Common/IFunctionBrowser.h"
 
#include <QWidget>
 
#include <memory>
#include <optional>
 
namespace Mantid {
namespace API {
class CompositeFunction;
class Workspace;
class ParameterTie;
} // namespace API
} // namespace Mantid
 
namespace MantidQt {
namespace MantidWidgets {
 
class FunctionTreeView;
class FunctionMultiDomainPresenter;
 
using namespace Mantid::API;
 
class EXPORT_OPT_MANTIDQT_COMMON FunctionBrowser : public QWidget, public IFunctionBrowser {
  Q_OBJECT
public:
  FunctionBrowser(QWidget *parent = nullptr, bool multi = false,
                  const std::vector<std::string> &categories = std::vector<std::string>());
  virtual ~FunctionBrowser() override;
  void clear() override;
  void setFunction(std::string const &funStr) override;
  void setFunction(IFunction_sptr fun);
  std::string getFunctionString() override;
  IFunction_sptr getFunction();
  bool hasFunction() const;
  IFunction_sptr getFunctionByIndex(std::string const &index);
  std::optional<std::string> currentFunctionIndex();
  void setParameter(std::string const &parameterName, double value);
  void setParameterError(std::string const &parameterName, double error);
  double getParameter(std::string const &parameterName) const;
  void updateParameters(const IFunction &fun) override;
  std::vector<std::string> getGlobalParameters() const;
  void setGlobalParameters(std::vector<std::string> const &globals);
  std::vector<std::string> getLocalParameters() const;
  int getNumberOfDatasets() const override;
  std::vector<std::string> getDatasetNames() const override;
  std::vector<std::string> getDatasetDomainNames() const override;
  double getLocalParameterValue(std::string const &parameterName, int i) const override;
  void setLocalParameterValue(std::string const &parameterName, int i, double value) override;
  void setLocalParameterValue(std::string const &parameterName, int i, double value, double error);
  double getLocalParameterError(std::string const &parameterName, int i) const;
  bool isLocalParameterFixed(std::string const &parameterName, int i) const override;
  void setLocalParameterFixed(std::string const &parameterName, int i, bool fixed) override;
  std::string getLocalParameterTie(std::string const &parameterName, int i) const override;
  void setLocalParameterTie(std::string const &parameterName, int i, std::string const &tie) override;
  IFunction_sptr getGlobalFunction() override;
  void updateMultiDatasetParameters(const IFunction &fun) override;
  void updateMultiDatasetAttributes(const IFunction &fun);
  void updateMultiDatasetParameters(const ITableWorkspace &paramTable) override;
  int getCurrentDataset() const override;
  void setColumnSizes(int s0, int s1, int s2 = -1);
  void setStretchLastColumn(bool stretch);
  void setErrorsEnabled(bool enabled) override;
  void clearErrors() override;
  void setBackgroundA0(double value);
  // hide the global options
  void hideGlobalCheckbox();
  // show the global options
  void showGlobalCheckbox();
 
signals:
  void parameterChanged(std::string const &funcIndex, std::string const &paramName);
  void attributeChanged(std::string const &attributeName);
  void functionStructureChanged();
  void currentFunctionChanged();
 
  void localParameterButtonClicked(std::string const &parName);
  void globalsChanged();
 
public slots:
 
  // Handling of multiple datasets
  void setNumberOfDatasets(int n) override;
  void setDatasets(const std::vector<std::string> &datasetNames) override;
  void setDatasets(const QList<FunctionModelDataset> &datasets) override;
  void resetLocalParameters();
  void setCurrentDataset(int i) override;
  void removeDatasets(const QList<int> &indices);
  void addDatasets(const std::vector<std::string> &names);
 
protected:
  std::unique_ptr<FunctionMultiDomainPresenter> m_presenter;
 
public:
  // Intended for testing only
  FunctionTreeView *view() const;
  std::string getFitFunctionString() const;
};
 
} // namespace MantidWidgets
} // namespace MantidQt