MantidWSIndexDialog.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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
 
//----------------------------------
// Includes
//----------------------------------
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidQtWidgets/Common/DllOption.h"
#include <QCheckBox>
#include <QComboBox>
#include <QDialog>
#include <QGroupBox>
#include <QLabel>
#include <QLineEdit>
#include <QList>
#include <QMap>
#include <QString>
#include <QVBoxLayout>
#include <QValidator>
 
#include <optional>
#include <set>
 
namespace MantidQt {
namespace MantidWidgets {
//----------------------------------
// Forward declarations
//----------------------------------
class IntervalList;
 
class EXPORT_OPT_MANTIDQT_COMMON Interval {
public:
  explicit Interval(int single);
  Interval(int start, int end);
  explicit Interval(const QString & /*intervalString*/);
  Interval(const Interval & /*copy*/);
 
  bool merge(const Interval & /*other*/);
  bool canMerge(const Interval & /*other*/) const;
  int start() const;
  int end() const;
  int length() const;
 
  std::set<int> getIntSet() const;
 
  bool contains(const Interval & /*other*/) const;
 
  std::string toStdString() const;
  QString toQString() const;
 
private:
  void init(int /*start*/, int /*end*/);
 
  int m_start, m_end;
};
 
class EXPORT_OPT_MANTIDQT_COMMON IntervalList {
public:
  IntervalList(void);
  explicit IntervalList(const QString & /*intervals*/);
  explicit IntervalList(const Interval & /*interval*/);
 
  const QList<Interval> &getList() const;
  int totalIntervalLength() const;
 
  std::string toStdString(int numOfIntervals = 6) const;
  QString toQString(int numOfIntervals = 6) const;
 
  void addInterval(int single);
  void addInterval(Interval /*interval*/);
  void addInterval(int start, int end);
  void addIntervals(QString /*intervals*/);
  void addIntervalList(const IntervalList & /*intervals*/);
  void setIntervalList(const IntervalList & /*intervals*/);
  void clear();
 
  std::set<int> getIntSet() const;
 
  bool contains(const Interval & /*other*/) const;
  bool contains(const IntervalList & /*other*/) const;
 
  static bool isParsable(const QString & /*input*/);
  static bool isParsable(const QString & /*input*/, const IntervalList & /*container*/);
 
  static IntervalList intersect(const IntervalList & /*aList*/, const Interval & /*bInterval*/);
  static IntervalList intersect(const IntervalList & /*a*/, const IntervalList & /*b*/);
 
private:
  QList<Interval> m_list;
};
 
class EXPORT_OPT_MANTIDQT_COMMON IntervalListValidator : public QValidator {
  Q_OBJECT
 
public:
  IntervalListValidator(QObject *parent, IntervalList intervals);
 
  State validate(QString & /*unused*/, int & /*unused*/) const override;
 
private:
  IntervalList m_intervalList;
};
 
class EXPORT_OPT_MANTIDQT_COMMON MantidWSIndexWidget : public QWidget {
  Q_OBJECT
 
  class QLineEditWithErrorMark : public QWidget {
  public:
    explicit QLineEditWithErrorMark(QWidget *parent = nullptr);
    ~QLineEditWithErrorMark() override {};
    QLineEdit *lineEdit() { return _lineEdit; };
    void setError(const QString &error);
 
  private:
    QLineEdit *_lineEdit;
    QLabel *m_validLbl;
  };
 
public:
  struct UserInputAdvanced {
    bool accepted;
    int plotIndex;
    QString axisName;
    QString logName;
    std::set<double> customLogValues;
    QList<QString> workspaceNames;
  };
 
  struct UserInput {
    QMultiMap<QString, std::set<int>> plots;
    bool simple;
    bool waterfall;
    bool tiled;
    bool errors;
    bool surface;
    bool contour;
    bool isAdvanced;
    std::optional<UserInputAdvanced> advanced;
  };
 
  static const QString WORKSPACE_NAME;
  static const QString WORKSPACE_INDEX;
  static const QString CUSTOM;
  static const QString SIMPLE_PLOT;
  static const QString WATERFALL_PLOT;
  static const QString SURFACE_PLOT;
  static const QString CONTOUR_PLOT;
 
  MantidWSIndexWidget(QWidget *parent, const Qt::WindowFlags &flags, const QList<QString> &wsNames,
                      const bool showWaterfallOption = false, const bool showTiledOption = false,
                      const bool isAdvanced = false);
 
  UserInput getSelections();
  QMultiMap<QString, std::set<int>> getPlots() const;
  bool is1DPlotSelected() const;
  bool isWaterfallPlotSelected() const;
  bool plotRequested();
  bool plotAllRequested();
  bool validatePlotOptions();
  bool isTiledPlotSelected() const;
  bool isSurfacePlotSelected() const;
  bool isContourPlotSelected() const;
  bool isErrorBarsSelected() const;
 
private slots:
  void editedWsField();
  void editedSpectraField();
  void onLogSelected(const QString &logName);
  void onPlotOptionChanged(const QString &logName);
 
private:
  void init();
  void initWorkspaceBox();
  void initSpectraBox();
  void initOptionsBoxes();
  void initLogs();
  void populateLogComboBox();
  Mantid::API::MatrixWorkspace_const_sptr getWorkspace(const QString &workspaceName) const;
  bool isSuitableForContourOrSurfacePlot() const;
  bool isSuitableForLogValues(const QString &plotOption) const;
  const QString getAxisName() const;
  const QString getLogName() const;
  const std::set<double> getCustomLogValues() const;
  void showPlotOptionsError(const QString &message);
  int getPlotIndex() const;
 
  void checkForSpectraAxes();
 
  void generateWsIndexIntervals();
  void generateSpectraNumIntervals();
 
  bool usingSpectraNumbers() const;
 
  bool m_spectra;
 
  bool m_waterfall;
 
  bool m_tiled;
 
  bool m_advanced;
 
  QLabel *m_wsMessage, *m_spectraMessage, *m_orMessage, *m_plotOptionLabel, *m_logLabel, *m_customLogLabel,
      *m_axisLabel;
  QLineEditWithErrorMark *m_wsField, *m_spectraField, *m_logValues;
  QGroupBox *m_logOptionsGroup;
  QVBoxLayout *m_outer, *m_wsBox, *m_spectraBox, *m_logBox, *m_optionsBox;
  QComboBox *m_plotOptions, *m_logSelector;
  QCheckBox *m_showErrorBars;
  QLineEditWithErrorMark *m_axisNameEdit;
 
  QList<QString> m_wsNames;
  IntervalList m_wsIndexIntervals, m_spectraNumIntervals;
  IntervalList m_wsIndexChoice, m_spectraNumChoice;
  bool m_usingWsIndexChoice = false, m_usingSprectraNumChoice = false;
};
 
class EXPORT_OPT_MANTIDQT_COMMON MantidWSIndexDialog : public QDialog {
  Q_OBJECT
 
public:
  MantidWSIndexDialog(QWidget *parent, const Qt::WindowFlags &flags, const QList<QString> &wsNames,
                      const bool showWaterfallOption = false, const bool showPlotAll = true,
                      const bool showTiledOption = false, const bool isAdvanced = false);
  MantidWSIndexWidget::UserInput getSelections();
  QMultiMap<QString, std::set<int>> getPlots() const;
  bool is1DPlotSelected() const;
  bool isWaterfallPlotSelected() const;
  bool isTiledPlotSelected() const;
  bool isSurfacePlotSelected() const;
  bool isContourPlotSelected() const;
  bool isErrorBarsSelected() const;
private slots:
  void plot();
  void plotAll();
 
private:
  MantidWSIndexWidget m_widget;
  void init(bool isAdvanced);
  void initButtons();
  bool m_plotAll;
  QPushButton *m_okButton, *m_cancelButton, *m_plotAllButton;
  QHBoxLayout *m_buttonBox;
  QVBoxLayout *m_outer;
};
} // namespace MantidWidgets
} // namespace MantidQt