MuonFitPropertyBrowser.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 "MantidQtWidgets/Common/FitPropertyBrowser.h"
#include "MantidQtWidgets/Common/IMuonFitDataModel.h"
#include "MantidQtWidgets/Common/IMuonFitFunctionModel.h"
#include "MantidQtWidgets/Common/MuonFunctionBrowser.h"
#include <QMap>
/* Forward declarations */
class QDockWidget;
class QLabel;
class QPushButton;
class QCheckBox;
class QMenu;
class QSignalMapper;
class QtTreePropertyBrowser;
class QtGroupPropertyManager;
class QtDoublePropertyManager;
class QtIntPropertyManager;
class QtBoolPropertyManager;
class QtStringPropertyManager;
class QtEnumPropertyManager;
class QtProperty;
class QtBrowserItem;
class QVBoxLayout;
class QGroupBox;
class QSplitter;
class QWidget;
 
namespace Mantid {
namespace API {
class IFitFunction;
class IPeakFunction;
class CompositeFunction;
} // namespace API
} // namespace Mantid
 
namespace MantidQt {
namespace MantidWidgets {
class PropertyHandler;
 
class EXPORT_OPT_MANTIDQT_COMMON MuonFitPropertyBrowser : public MantidQt::MantidWidgets::FitPropertyBrowser,
                                                          public MantidQt::MantidWidgets::IMuonFitFunctionModel,
                                                          public IMuonFitDataModel {
  Q_OBJECT
 
public:
  MuonFitPropertyBrowser(QWidget *parent = nullptr, QObject *mantidui = nullptr);
  void init() override;
  void setWorkspaceName(const QString &wsName) override;
  void finishHandle(const Mantid::API::IAlgorithm *alg) override;
  void finishHandleTF(const Mantid::API::IAlgorithm *alg);
  void finishHandleNormal(const Mantid::API::IAlgorithm *alg);
  void addExtraWidget(QWidget *widget);
  void addFitBrowserWidget(QWidget *widget, MantidQt::MantidWidgets::FunctionBrowser *functionBrowser);
  void setFunction(const Mantid::API::IFunction_sptr func) override;
  void runFit() override;
  void runSequentialFit() override;
  Mantid::API::IFunction_sptr getFunction() const override { return getFittingFunction(); }
  void setWorkspaceNames(const QStringList &wsNames) override;
  std::string outputName() const override;
  static const std::string SIMULTANEOUS_PREFIX;
  void setSimultaneousLabel(const std::string &label) override { m_simultaneousLabel = label; }
  std::vector<std::string> getWorkspaceNamesToFit() const override { return m_workspacesToFit; }
  void userChangedDataset(int index) override { emit userChangedDatasetIndex(index); }
  void setMultiFittingMode(bool enabled) override;
  bool isMultiFittingMode() const override;
 
  void continueAfterChecks(bool sequential) override;
  void doRemoveGuess() override { emit removeGuess(); }
  void doPlotGuess() override { emit plotGuess(); }
  bool hasGuess() const override;
 
  virtual void setFitEnabled(bool yes) override;
  void doTFAsymmFit();
  void setAvailableGroups(const QStringList &groups);
  void setAvailablePeriods(const QStringList &periods);
 
  QStringList getChosenGroups() const;
  QStringList getChosenPeriods() const;
  void setTFAsymm(bool state);
  void clearChosenGroups() const;
  void setAllGroups();
  void setGroupNames(const std::vector<std::string> groupNames);
  void setAllPairs();
  void setAllGroupsOrPairs(const bool isItGroup);
  void clearChosenPeriods() const;
  void setChosenGroup(const QString &group);
  void setAllPeriods();
  void setChosenPeriods(const QString &period);
  void setSingleFitLabel(const std::string &name);
  void setNormalization(const std::string &name);
  void checkFitEnabled();
public slots:
  void fit() override;
  void sequentialFit() override;
 
  void executeFitMenu(const QString &item) override;
  void groupBtnPressed();
  void periodBtnPressed();
  void generateBtnPressed();
  void combineBtnPressed();
  void setNumPeriods(size_t numPeriods);
  void addPeriodCheckboxToMap(const QString &name);
  void updatePeriods();
 
signals:
  void sequentialFitRequested();
  void functionUpdateRequested() override;
  void functionUpdateAndFitRequested(bool sequential) override;
  void workspacesToFitChanged(int n) override;
  void userChangedDatasetIndex(int index) override;
  void fitRawDataClicked(bool enabled) override;
  void groupBoxClicked();
  void periodBoxClicked();
  void reselctGroupClicked(bool enabled);
  void preFitChecksRequested(bool sequential) override;
  void TFPlot(QString wsName);
 
protected:
  void showEvent(QShowEvent *e) override;
  void setNormalization();
 
private slots:
  void doubleChanged(QtProperty *prop) override;
  void boolChanged(QtProperty *prop) override;
  void enumChanged(QtProperty *prop) override;
 
private:
  void populateFunctionNames() override;
  bool isWorkspaceValid(Mantid::API::Workspace_sptr /*unused*/) const override;
  void finishAfterSimultaneousFit(const Mantid::API::IAlgorithm *fitAlg, const int nWorkspaces) const;
  void finishAfterTFSimultaneousFit(const Mantid::API::IAlgorithm *alg, const std::string &baseName) const;
  void setFitWorkspaces(const std::string &input);
  std::string getUnnormName(const std::string wsName);
  void ConvertFitFunctionForMuonTFAsymmetry(bool enabled);
  void setTFAsymmMode(bool state);
  void clearGroupCheckboxes();
  void addGroupCheckbox(const QString &name);
  void genGroupWindow();
  void genPeriodWindow();
  void genCombinePeriodWindow();
  void updateGroupDisplay();
  void updatePeriodDisplay();
  void setChosenPeriods(const QStringList &chosenPeriods);
  void clearPeriodCheckboxes();
  void addPeriodCheckbox(const QString &name);
  void updatePeriods(const int j);
  bool isPeriodValid(const QString &name);
  std::string TFExtension() const;
  void updateTFPlot();
  QSplitter *m_widgetSplitter, *m_mainSplitter;
  std::vector<std::string> m_workspacesToFit;
  std::string m_simultaneousLabel;
  QtProperty *m_normalization;
  QStringList m_normalizationValue;
  QtProperty *m_keepNorm;
  QtProperty *m_TFAsymmMode;
  QtBrowserItem *m_multiFitSettingsGroup;
  QtProperty *m_groupsToFit;
  QStringList m_groupsToFitOptions;
  QMap<QString, QtProperty *> m_groupBoxes;
  QtProperty *m_showGroup;
  QStringList m_showGroupValue;
 
  QtProperty *m_periodsToFit;
  QStringList m_periodsToFitOptions;
  QMap<QString, QtProperty *> m_periodBoxes;
  QtProperty *m_showPeriods;
  QStringList m_showPeriodValue;
  QLineEdit *m_positiveCombo;
  QLineEdit *m_negativeCombo;
 
  QPushButton *m_reselectGroupBtn;
  QPushButton *m_reselectPeriodBtn;
  QPushButton *m_generateBtn;
  QGroupBox *m_btnGroup;
  QDialog *m_groupWindow;
  QDialog *m_periodWindow;
  QDialog *m_comboWindow;
  MantidQt::MantidWidgets::FunctionBrowser *m_functionBrowser;
  std::vector<std::string> m_groupsList;
 
  // stores if this is in multi fitting mode
  bool m_isMultiFittingMode;
 
  QString m_autoBackground;
};
 
std::map<std::string, double> readMultipleNormalization();
} // namespace MantidWidgets
} // namespace MantidQt