FitOptionsBrowser.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 "MantidQtWidgets/Common/FittingMode.h"
 
#include <QMap>
#include <QStringList>
#include <QWidget>
 
/* Forward declarations */
class QtProperty;
class QtTreePropertyBrowser;
class QtDoublePropertyManager;
class QtIntPropertyManager;
class QtBoolPropertyManager;
class QtStringPropertyManager;
class QtEnumPropertyManager;
class QtGroupPropertyManager;
class QSettings;
 
namespace Mantid {
namespace Kernel {
class Property;
}
namespace API {
class IAlgorithm;
}
} // namespace Mantid
 
namespace MantidQt {
namespace MantidWidgets {
 
class EXPORT_OPT_MANTIDQT_COMMON FitOptionsBrowserSettings {
public:
  explicit FitOptionsBrowserSettings(QMap<QString, QString> propertyValues = {});
 
  [[nodiscard]] const QMap<QString, QString> &values() const;
 
  [[nodiscard]] static FitOptionsBrowserSettings readSettings(const QSettings &settings,
                                                              const QStringList &propertyNames);
  static void saveSettings(QSettings &settings, const FitOptionsBrowserSettings &snapshot);
 
private:
  QMap<QString, QString> m_values;
};
 
class EXPORT_OPT_MANTIDQT_COMMON FitOptionsBrowser : public QWidget {
  Q_OBJECT
public:
  FitOptionsBrowser(QWidget *parent = nullptr, FittingMode fitType = FittingMode::SIMULTANEOUS);
  ~FitOptionsBrowser();
  QString getProperty(const QString &name) const;
  void setProperty(const QString &name, const QString &value);
  void copyPropertiesToAlgorithm(Mantid::API::IAlgorithm &fit) const;
  [[nodiscard]] FitOptionsBrowserSettings readSettings(const QSettings &settings) const;
  void restoreSettings(const FitOptionsBrowserSettings &settings);
  [[nodiscard]] FitOptionsBrowserSettings captureSettings() const;
  FittingMode getCurrentFittingType() const;
  void setCurrentFittingType(FittingMode fitType);
  void lockCurrentFittingType(FittingMode fitType);
  void unlockCurrentFittingType();
  void setLogNames(const QStringList &logNames);
  void setParameterNamesForPlotting(const QStringList &parNames);
  QString getParameterToPlot() const;
  bool addPropertyToBlacklist(const QString &);
 
signals:
  void changedToSequentialFitting();
  void changedToSimultaneousFitting();
  // emitted when m_doubleManager reports a change
  void doublePropertyChanged(const QString &propertyName);
 
protected:
  QtProperty *addDoubleProperty(const QString &propertyName);
  void displayProperty(const QString &propertyName, bool show = true);
  void displaySequentialFitProperties();
 
private slots:
  void enumChanged(QtProperty * /*prop*/);
  void doubleChanged(QtProperty *property);
 
private:
  void createBrowser();
  void initFittingTypeProp();
  void createProperties();
  void createCommonProperties();
  void createSimultaneousFitProperties();
  void createSequentialFitProperties();
  void updateMinimizer();
  void switchFitType();
  void displayNormalFitProperties();
 
  QtProperty *createPropertyProperty(Mantid::Kernel::Property *prop);
 
  void addProperty(const QString &name, QtProperty *prop, QString (FitOptionsBrowser::*getter)(QtProperty *) const,
                   void (FitOptionsBrowser::*setter)(QtProperty *, const QString &));
 
  void removeProperty(const QString &name);
 
  //  Setters and getters
  QString getMinimizer(QtProperty * /*unused*/) const;
  void setMinimizer(QtProperty * /*unused*/, const QString & /*value*/);
 
  QString getIntProperty(QtProperty * /*prop*/) const;
  void setIntProperty(QtProperty * /*prop*/, const QString & /*value*/);
  QString getDoubleProperty(QtProperty * /*prop*/) const;
  void setDoubleProperty(QtProperty * /*prop*/, const QString & /*value*/);
  QString getBoolProperty(QtProperty * /*prop*/) const;
  void setBoolProperty(QtProperty * /*prop*/, const QString & /*value*/);
  QString getStringEnumProperty(QtProperty * /*prop*/) const;
  void setStringEnumProperty(QtProperty * /*prop*/, const QString & /*value*/);
  QString getStringProperty(QtProperty * /*prop*/) const;
  void setStringProperty(QtProperty * /*prop*/, const QString & /*value*/);
 
  void setPropertyEnumValues(QtProperty *prop, const QStringList &values);
 
  QtBoolPropertyManager *m_boolManager;
  QtIntPropertyManager *m_intManager;
  QtDoublePropertyManager *m_doubleManager;
  QtStringPropertyManager *m_stringManager;
  QtEnumPropertyManager *m_enumManager;
  QtGroupPropertyManager *m_groupManager;
 
  QtProperty *m_fittingTypeProp;
  QtProperty *m_minimizerGroup;
  QtProperty *m_minimizer;
  QtProperty *m_costFunction;
  QtProperty *m_maxIterations;
  QtProperty *m_evaluationType;
  QtProperty *m_peakRadius;
 
  // Fit properties
  QtProperty *m_output;
  QtProperty *m_ignoreInvalidData;
 
  // PlotPeakByLogValue properties
  QList<QtProperty *> m_sequentialProperties;
  QtProperty *m_plotPeakByLogValueFitType;
  QtProperty *m_outputWorkspace;
  QtProperty *m_logValue;
  QtProperty *m_plotParameter;
 
  QtTreePropertyBrowser *m_browser;
 
  int m_decimals;
 
  using SetterType = void (FitOptionsBrowser::*)(QtProperty *, const QString &);
  using GetterType = QString (FitOptionsBrowser::*)(QtProperty *) const;
  QMap<QString, QtProperty *> m_propertyNameMap;
  QMap<QtProperty const *, SetterType> m_setters;
  QMap<QtProperty const *, GetterType> m_getters;
 
  FittingMode m_fittingType;
  QList<QtProperty *> m_simultaneousProperties;
  QList<QtProperty *> m_blacklist;
};
 
} // namespace MantidWidgets
 
} // namespace MantidQt