SlicingAlgorithmDialog.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
 
//----------------------
// Includes
//----------------------
#include "DllOption.h"
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/IAlgorithm.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidQtWidgets/Common/AlgorithmDialog.h"
#include "ui_SlicingAlgorithmDialog.h"
 
namespace MantidQt {
namespace MantidWidgets {
 
using PropertyDimensionMap = QMap<QString, QString>;
 
/*
Class SlicingAlgorithmDialog
Abstract SlicingAlgorithm Dialog geared for MD Slicing type algorithms
 
This custom dialog provides two advantages over the default custom generated
one.
 
1) It dynamically creates dimension input controls based on the nature of the
input MD workspace
2) It pre-populates those dimension input controls based on existing values.
 
*/
class EXPORT_OPT_MANTIDQT_COMMON SlicingAlgorithmDialog : public MantidQt::API::AlgorithmDialog {
  Q_OBJECT
public:
  SlicingAlgorithmDialog(QWidget *parent = nullptr);
 
  ~SlicingAlgorithmDialog() override;
 
protected:
  Ui::SlicingAlgorithmDialog ui;
 
  void commonSliceMDSetup(const bool /*isSliceMD*/);
 
  void buildDimensionInputs(const bool bForceForget = false);
 
protected slots:
 
  void onWorkspaceChanged();
 
  void onAxisAlignedChanged(bool /*unused*/);
 
  void onBrowse();
 
  void onMaxFromInput(bool /*unused*/);
 
  void onRebuildDimensions();
 
  void onCalculateChanged(bool checked);
 
private:
  enum History { Remember, Forget };
 
  enum HistoryChanged { HasChanged, HasNotChanged };
 
  void initLayout() override;
 
  bool doAxisAligned() const;
 
  QString getCurrentInputWorkspaceName() const;
 
  QString getHistoricalInputWorkspaceName() const;
 
  QString getCurrentOutputWorkspaceName() const;
 
  void makeDimensionInputs(const QString &propertyPrefix, QLayout *owningLayout,
                           QString (*format)(const Mantid::Geometry::IMDDimension_const_sptr &), History history);
 
  History useHistory(const HistoryChanged &criticalChange, const bool bForceForget);
 
  void cleanLayoutOfDimensions(QLayout *layout);
 
  void clearExistingDimensions();
 
  HistoryChanged hasDimensionHistoryChanged() const;
 
  virtual void customiseInitLayout() = 0;
 
  void loadSettings();
 
  void saveSettings();
 
  bool doAutoFillDimensions() const;
};
 
/*
Class SliceMDDialog
Concrete SlicingAlgorithm Dialog geared for SliceMD
*/
class EXPORT_OPT_MANTIDQT_COMMON SliceMDDialog : public SlicingAlgorithmDialog {
  Q_OBJECT
public:
  SliceMDDialog(QWidget *parent = nullptr) : SlicingAlgorithmDialog(parent) {}
 
  ~SliceMDDialog() override = default;
 
  void customiseInitLayout() override;
};
 
/*
Class BinMDDialog
Concrete BinMDDialog Dialog geared for BinMD
*/
class EXPORT_OPT_MANTIDQT_COMMON BinMDDialog : public SlicingAlgorithmDialog {
  Q_OBJECT
public:
  BinMDDialog(QWidget *parent = nullptr) : SlicingAlgorithmDialog(parent) {}
  ~BinMDDialog() override = default;
  void customiseInitLayout() override;
};
} // namespace MantidWidgets
} // namespace MantidQt