BinaryOperationMD.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidAPI/Algorithm.h"
#include "MantidAPI/IMDEventWorkspace_fwd.h"
#include "MantidAPI/IMDWorkspace.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include "MantidDataObjects/MDHistoWorkspace.h"
#include "MantidDataObjects/WorkspaceSingleValue.h"
#include "MantidMDAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL BinaryOperationMD : public API::Algorithm {
public:
  const std::string name() const override;
  int version() const override;
  const std::string category() const override;
  const std::string summary() const override {
    return "Abstract base class for binary operations on IMDWorkspaces, e.g. A "
           "= B + C or A = B / C.";
  }
 
protected:
  ~BinaryOperationMD() = default;
  virtual bool commutative() const = 0;
 
  virtual void checkInputs() = 0;
 
  virtual void execEvent() = 0;
 
  virtual void execHistoHisto(Mantid::DataObjects::MDHistoWorkspace_sptr out,
                              Mantid::DataObjects::MDHistoWorkspace_const_sptr operand) = 0;
 
  virtual void execHistoScalar(Mantid::DataObjects::MDHistoWorkspace_sptr out,
                               Mantid::DataObjects::WorkspaceSingleValue_const_sptr scalar) = 0;
 
  virtual std::string inputPropName1() const { return "LHSWorkspace"; }
  virtual std::string inputPropName2() const { return "RHSWorkspace"; }
  virtual std::string outputPropName() const { return "OutputWorkspace"; }
 
  void init() override;
  virtual void initExtraProperties();
  void exec() override;
 
  Mantid::API::IMDWorkspace_sptr m_lhs;
  Mantid::API::IMDWorkspace_sptr m_rhs;
  Mantid::API::IMDWorkspace_sptr m_out;
 
  Mantid::API::IMDEventWorkspace_sptr m_lhs_event;
  Mantid::API::IMDEventWorkspace_sptr m_rhs_event;
  Mantid::DataObjects::MDHistoWorkspace_sptr m_lhs_histo;
  Mantid::DataObjects::MDHistoWorkspace_sptr m_rhs_histo;
  Mantid::DataObjects::WorkspaceSingleValue_sptr m_lhs_scalar;
  Mantid::DataObjects::WorkspaceSingleValue_sptr m_rhs_scalar;
 
  Mantid::API::IMDEventWorkspace_sptr m_operand_event;
  Mantid::API::IMDEventWorkspace_sptr m_out_event;
 
  Mantid::DataObjects::MDHistoWorkspace_sptr m_operand_histo;
  Mantid::DataObjects::MDHistoWorkspace_sptr m_out_histo;
 
  Mantid::DataObjects::WorkspaceSingleValue_sptr m_operand_scalar;
};
 
} // namespace MDAlgorithms
} // namespace Mantid