Multiply.cpp

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 +
#include "MantidAlgorithms/Multiply.h"
 
using namespace Mantid::API;
using namespace Mantid::Kernel;
using namespace Mantid::DataObjects;
using std::size_t;
 
namespace Mantid::Algorithms {
// Register the class into the algorithm factory
DECLARE_ALGORITHM(Multiply)
 
void Multiply::performBinaryOperation(const HistogramData::Histogram &lhs, const HistogramData::Histogram &rhs,
                                      HistogramData::HistogramY &YOut, HistogramData::HistogramE &EOut) {
  const size_t bins = lhs.e().size();
  for (size_t j = 0; j < bins; ++j) {
    // Get references to the input Y's
    const double leftY = lhs.y()[j];
    const double rightY = rhs.y()[j];
 
    // error multiplying two uncorrelated numbers, re-arrange so that you don't
    // get infinity if leftY or rightY == 0
    // (Sa/a)2 + (Sb/b)2 = (Sc/c)2
    // (Sc)2 = (Sa c/a)2 + (Sb c/b)2
    //       = (Sa b)2 + (Sb a)2
    EOut[j] = sqrt(pow(lhs.e()[j] * rightY, 2) + pow(rhs.e()[j] * leftY, 2));
 
    // Copy the result last in case one of the input workspaces is also any
    // output
    YOut[j] = leftY * rightY;
  }
}
 
void Multiply::performBinaryOperation(const HistogramData::Histogram &lhs, const double rhsY, const double rhsE,
                                      HistogramData::HistogramY &YOut, HistogramData::HistogramE &EOut) {
  const size_t bins = lhs.e().size();
  for (size_t j = 0; j < bins; ++j) {
    // Get reference to input Y
    const double leftY = lhs.y()[j];
 
    // see comment in the function above for the error formula
    EOut[j] = sqrt(pow(lhs.e()[j] * rhsY, 2) + pow(rhsE * leftY, 2));
 
    // Copy the result last in case one of the input workspaces is also any
    // output
    YOut[j] = leftY * rhsY;
  }
}
 
void Multiply::setOutputUnits(const API::MatrixWorkspace_const_sptr lhs, const API::MatrixWorkspace_const_sptr rhs,
                              API::MatrixWorkspace_sptr out) {
  if (!lhs->isDistribution() || !rhs->isDistribution())
    out->setDistribution(false);
}
 
// ===================================== EVENT LIST BINARY OPERATIONS
// ==========================================
void Multiply::performEventBinaryOperation(DataObjects::EventList &lhs, const DataObjects::EventList &rhs) {
  // We must histogram the rhs event list to multiply.
  MantidVec rhsY, rhsE;
  rhs.generateHistogram(rhs.x().rawData(), rhsY, rhsE);
  lhs.multiply(rhs.x().rawData(), rhsY, rhsE);
}
 
void Multiply::performEventBinaryOperation(DataObjects::EventList &lhs, const MantidVec &rhsX, const MantidVec &rhsY,
                                           const MantidVec &rhsE) {
  // Multiply is implemented at the EventList level.
  lhs.multiply(rhsX, rhsY, rhsE);
}
 
void Multiply::performEventBinaryOperation(DataObjects::EventList &lhs, const double &rhsY, const double &rhsE) {
  // Multiply is implemented at the EventList level.
  lhs.multiply(rhsY, rhsE);
}
 
//---------------------------------------------------------------------------------------------
void Multiply::checkRequirements() {
  // Can commute workspaces?
  m_flipSides = (m_rhs->size() > m_lhs->size());
 
  // Both are vertical columns with one bin?
  if ((m_rhsBlocksize == 1) && (m_lhsBlocksize == 1)) {
    // Flip it if the RHS is event and you could keep events
    if (m_erhs && !m_elhs)
      m_flipSides = true;
  }
 
  // The RHS operand will be histogrammed first.
  m_useHistogramForRhsEventWorkspace = true;
 
  if ((m_elhs && !m_flipSides) || (m_flipSides && (m_erhs))) {
    // The lhs (or RHS if it will get flipped) workspace
    //  is an EventWorkspace. It can be divided while keeping event-ishness
    // Output will be EW
    m_keepEventWorkspace = true;
    // Histogram sizes need not match
    m_matchXSize = false;
  } else {
    m_keepEventWorkspace = false;
    m_matchXSize = true;
  }
}
 
//--------------------------------------------------------------------------------------------
std::string Multiply::checkSizeCompatibility(const API::MatrixWorkspace_const_sptr lhs,
                                             const API::MatrixWorkspace_const_sptr rhs) const {
  if (!m_keepEventWorkspace && !m_AllowDifferentNumberSpectra) {
    // Fallback on the default checks
    return CommutativeBinaryOperation::checkSizeCompatibility(lhs, rhs);
  } else {
 
    // A SingleValueWorkspace on the right, or matches anything
    if (rhs->size() == 1)
      return "";
 
    // A SingleValueWorkspace on the left only matches if rhs was single value
    // too. Why are you using mantid to do simple math?!?
    if (lhs->size() == 1)
      return "The left side cannot contain a single value if the right side "
             "isn't also a single value.";
 
    // RHS only has one value (1D vertical), so the number of histograms needs
    // to match.
    // Each lhs spectrum will be divided by that scalar
    if (m_rhsBlocksize == 1 && lhs->getNumberHistograms() == rhs->getNumberHistograms())
      return "";
 
    if (m_matchXSize) {
      // Past this point, for a 2D WS operation, we require the X arrays to
      // match. Note this only checks the first spectrum
      if (!WorkspaceHelpers::matchingBins(*lhs, *rhs, true)) {
        return "X arrays must match when multiplying 2D workspaces.";
      }
    }
 
    // We don't need to check for matching bins for events. Yay events!
    const size_t rhsSpec = rhs->getNumberHistograms();
 
    // If the rhs has a single spectrum, then we can divide. The block size does
    // NOT need to match,
    if (rhsSpec == 1)
      return "";
 
    // Are we allowing the division by different # of spectra, using detector
    // IDs to match up?
    if (m_AllowDifferentNumberSpectra) {
      return "";
    }
 
    // Otherwise, the number of histograms needs to match, but the block size of
    // each does NOT need to match.
 
    if (lhs->getNumberHistograms() == rhs->getNumberHistograms()) {
      return "";
    } else {
      return "Number of histograms not identical.";
    }
  }
}
 
} // namespace Mantid::Algorithms