PlusMD.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 "MantidDataObjects/MDEventWorkspace.h"
#include "MantidMDAlgorithms/BinaryOperationMD.h"
 
namespace Mantid {
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL PlusMD : public BinaryOperationMD {
public:
  const std::string name() const override { return "PlusMD"; };
  const std::string summary() const override {
    return "Sum two MDHistoWorkspaces or merges two MDEventWorkspaces together "
           "by combining their events together in one workspace.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"MinusMD", "MultiplyMD", "DivideMD", "PowerMD"}; }
 
private:
  bool commutative() const override;
 
  void checkInputs() override;
 
  void execEvent() override;
 
  void execHistoHisto(Mantid::DataObjects::MDHistoWorkspace_sptr out,
                      Mantid::DataObjects::MDHistoWorkspace_const_sptr operand) override;
 
  void execHistoScalar(Mantid::DataObjects::MDHistoWorkspace_sptr out,
                       Mantid::DataObjects::WorkspaceSingleValue_const_sptr scalar) override;
 
  template <typename MDE, size_t nd> void doPlus(typename Mantid::DataObjects::MDEventWorkspace<MDE, nd>::sptr ws);
 
  Mantid::API::IMDEventWorkspace_sptr iws1;
  Mantid::API::IMDEventWorkspace_sptr iws2;
};
 
} // namespace MDAlgorithms
} // namespace Mantid