BinaryOperation.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/Run.h"
#include "MantidAPI/SpectrumInfo.h"
#include "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidAPI/Workspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventList.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidHistogramData/Histogram.h"
 
#include <span>
 
namespace Mantid {
namespace Algorithms {
 
enum OperandType { eEventList = 0, eHistogram = 1, eNumber = 2 };
 
class MANTID_ALGORITHMS_DLL BinaryOperation : public API::Algorithm {
public:
  const std::string category() const override { return "Arithmetic"; }
 
  using BinaryOperationTable = std::vector<int64_t>;
  using BinaryOperationTable_sptr = std::shared_ptr<BinaryOperationTable>;
 
  static BinaryOperationTable_sptr buildBinaryOperationTable(const API::MatrixWorkspace_const_sptr &lhs,
                                                             const API::MatrixWorkspace_const_sptr &rhs);
 
protected:
  // Overridden Algorithm methods
  void exec() override;
  void init() override;
 
  bool handleSpecialDivideMinus();
 
  virtual void execEvent(DataObjects::EventWorkspace_const_sptr lhs, DataObjects::EventWorkspace_const_sptr rhs);
 
  virtual std::string inputPropName1() const { return "LHSWorkspace"; }
  virtual std::string inputPropName2() const { return "RHSWorkspace"; }
  virtual std::string outputPropName() const { return "OutputWorkspace"; }
 
  virtual bool checkCompatibility(const API::MatrixWorkspace_const_sptr lhs,
                                  const API::MatrixWorkspace_const_sptr rhs) const;
 
  virtual bool checkEventCompatibility(const API::MatrixWorkspace_const_sptr lhs,
                                       const API::MatrixWorkspace_const_sptr rhs);
 
  virtual std::string checkSizeCompatibility(const API::MatrixWorkspace_const_sptr lhs,
                                             const API::MatrixWorkspace_const_sptr rhs) const;
 
  virtual bool propagateSpectraMask(const API::SpectrumInfo &lhsSpectrumInfo, const API::SpectrumInfo &rhsSpectrumInfo,
                                    const int64_t index, API::MatrixWorkspace &out, API::SpectrumInfo &outSpectrumInfo);
 
  virtual void performBinaryOperation(const HistogramData::Histogram &lhs, const HistogramData::Histogram &rhs,
                                      HistogramData::HistogramY &YOut, HistogramData::HistogramE &EOut) = 0;
 
  virtual void performBinaryOperation(const HistogramData::Histogram &lhs, const double rhsY, const double rhsE,
                                      HistogramData::HistogramY &YOut, HistogramData::HistogramE &EOut) = 0;
 
  // ===================================== EVENT LIST BINARY OPERATIONS
  // ==========================================
 
  virtual void performEventBinaryOperation(DataObjects::EventList &lhs, const DataObjects::EventList &rhs);
 
  virtual void performEventBinaryOperation(DataObjects::EventList &lhs, std::span<double const> rhsX,
                                           std::span<double const> rhsY, std::span<double const> rhsE);
 
  virtual void performEventBinaryOperation(DataObjects::EventList &lhs, const double &rhsY, const double &rhsE);
 
  virtual void setOutputUnits(const API::MatrixWorkspace_const_sptr lhs, const API::MatrixWorkspace_const_sptr rhs,
                              API::MatrixWorkspace_sptr out) {
    (void)lhs; // Avoid compiler warning
    (void)rhs;
    (void)out;
  }
 
  virtual void operateOnRun(const API::Run &lhs, const API::Run &rhs, API::Run &ans) const {
    (void)lhs; // Avoid compiler warning
    (void)rhs;
    (void)ans;
  };
 
  OperandType getOperandType(const API::MatrixWorkspace_const_sptr &ws);
 
  virtual void checkRequirements();
 
  // ------- Workspaces being worked on --------
  API::MatrixWorkspace_const_sptr m_lhs;
  DataObjects::EventWorkspace_const_sptr m_elhs;
 
  API::MatrixWorkspace_const_sptr m_rhs;
  DataObjects::EventWorkspace_const_sptr m_erhs;
 
  API::MatrixWorkspace_sptr m_out;
  DataObjects::EventWorkspace_sptr m_eout;
 
  bool m_AllowDifferentNumberSpectra{false};
  bool m_ClearRHSWorkspace{false};
  size_t m_lhsBlocksize;
  size_t m_rhsBlocksize;
 
  bool m_lhsRagged{false};
  bool m_rhsRagged{false};
  //------ Requirements -----------
 
  bool m_matchXSize{false};
 
  bool m_flipSides{false};
 
  bool m_keepEventWorkspace{false};
 
  bool m_useHistogramForRhsEventWorkspace{false};
 
  bool m_do2D_even_for_SingleColumn_on_rhs{false};
 
private:
  void doSingleValue();
  void doSingleSpectrum();
  void doSingleColumn();
  void do2D(bool mismatchedSpectra);
 
  void propagateBinMasks(const API::MatrixWorkspace_const_sptr &rhs, const API::MatrixWorkspace_sptr &out);
  std::unique_ptr<API::Progress> m_progress = nullptr;
};
 
} // namespace Algorithms
} // namespace Mantid