SetMDUsingMask.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 "MantidMDAlgorithms/SetMDUsingMask.h"
#include "MantidAPI/IMDHistoWorkspace.h"
#include "MantidAPI/IMDWorkspace.h"
#include "MantidDataObjects/MDHistoWorkspace.h"
#include <cfloat>
 
using namespace Mantid::Kernel;
using namespace Mantid::API;
using namespace Mantid::DataObjects;
 
namespace Mantid::MDAlgorithms {
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(SetMDUsingMask)
 
//----------------------------------------------------------------------------------------------
const std::string SetMDUsingMask::name() const { return "SetMDUsingMask"; }
 
int SetMDUsingMask::version() const { return 1; }
 
const std::string SetMDUsingMask::category() const { return "MDAlgorithms\\MDArithmetic"; }
 
//----------------------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------------------
void SetMDUsingMask::init() {
  declareProperty(std::make_unique<WorkspaceProperty<IMDHistoWorkspace>>("InputWorkspace", "", Direction::Input),
                  "An input MDHistoWorkspace.");
  declareProperty(std::make_unique<WorkspaceProperty<IMDHistoWorkspace>>("MaskWorkspace", "", Direction::Input),
                  "A mask MDHistoWorkspace, where true indicates where to set the value.");
 
  declareProperty(std::make_unique<WorkspaceProperty<IMDHistoWorkspace>>("ValueWorkspace", "", Direction::Input,
                                                                         PropertyMode::Optional),
                  "Workspace to copy to the output workspace over the input. Optional - "
                  "specify this or Value.");
 
  declareProperty("Value", DBL_MAX,
                  "Single number to set in the output "
                  "workspace. Optional - specify this or "
                  "ValueWorkspace");
 
  declareProperty(std::make_unique<WorkspaceProperty<IMDHistoWorkspace>>("OutputWorkspace", "", Direction::Output),
                  "An output MDHistoWorkspace.");
}
 
//----------------------------------------------------------------------------------------------
void SetMDUsingMask::exec() {
  IMDHistoWorkspace_sptr inIWS = getProperty("InputWorkspace");
  IMDHistoWorkspace_sptr maskIWS = getProperty("MaskWorkspace");
  IMDHistoWorkspace_sptr outIWS = getProperty("OutputWorkspace");
  IMDHistoWorkspace_sptr valueIWS = getProperty("ValueWorkspace");
  double value = getProperty("Value");
 
  bool useValueWS = (value == DBL_MAX);
 
  if (useValueWS && !valueIWS)
    throw std::invalid_argument("You must specify either ValueWorkspace or Value.");
  if (!useValueWS && valueIWS)
    throw std::invalid_argument("You must specify either ValueWorkspace or Value, not both!");
 
  if (maskIWS->getNumDims() != inIWS->getNumDims())
    throw std::invalid_argument("Input and Mask workspace need to have the same number of dimensions.");
  if (maskIWS->getNPoints() != inIWS->getNPoints())
    throw std::invalid_argument("Input and Mask workspace need to have the same number of points.");
  if (valueIWS) {
    if (maskIWS->getNumDims() != valueIWS->getNumDims())
      throw std::invalid_argument("Input and Value workspace need to have the "
                                  "same number of dimensions.");
    if (maskIWS->getNPoints() != valueIWS->getNPoints())
      throw std::invalid_argument("Input and Value workspace need to have the same number of points.");
  }
 
  if (outIWS != inIWS) {
    // Not in-place. So clone the input to the output
    auto clone = createChildAlgorithm("CloneMDWorkspace", 0.0, 0.5, true);
    clone->setProperty("InputWorkspace", std::dynamic_pointer_cast<IMDWorkspace>(inIWS));
    clone->executeAsChildAlg();
    IMDWorkspace_sptr temp = clone->getProperty("OutputWorkspace");
    outIWS = std::dynamic_pointer_cast<IMDHistoWorkspace>(temp);
  }
 
  MDHistoWorkspace_sptr outWS = std::dynamic_pointer_cast<MDHistoWorkspace>(outIWS);
  MDHistoWorkspace_sptr maskWS = std::dynamic_pointer_cast<MDHistoWorkspace>(maskIWS);
  MDHistoWorkspace_sptr valueWS = std::dynamic_pointer_cast<MDHistoWorkspace>(valueIWS);
 
  if (!outWS || !maskWS)
    throw std::runtime_error("Error creating output workspace.");
 
  // Set either using the WS or the single value
  if (useValueWS)
    outWS->setUsingMask(*maskWS, *valueWS);
  else
    outWS->setUsingMask(*maskWS, value, 0.0 /* assume zero error */);
 
  // Save the output
  setProperty("OutputWorkspace", outIWS);
}
 
} // namespace Mantid::MDAlgorithms