RebinRagged2.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2023 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/RebinRagged2.h"
 
#include "MantidAPI/HistoWorkspace.h"
#include "MantidDataObjects/EventList.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidDataObjects/WorkspaceCreation.h"
#include "MantidHistogramData/HistogramBuilder.h"
#include "MantidHistogramData/Rebin.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/VectorHelper.h"
 
namespace Mantid::Algorithms {
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(RebinRagged)
 
using namespace API;
using namespace Kernel;
using DataObjects::EventList;
using DataObjects::EventWorkspace;
using DataObjects::EventWorkspace_const_sptr;
using HistogramData::HistogramBuilder;
 
//----------------------------------------------------------------------------------------------
 
const std::string RebinRagged::name() const { return "RebinRagged"; }
 
int RebinRagged::version() const { return 2; }
 
const std::string RebinRagged::category() const { return "Transforms\\Splitting"; }
 
const std::string RebinRagged::summary() const {
  return "Rebin each spectrum of a workspace independently. There is only one delta allowed per spectrum";
}
 
//----------------------------------------------------------------------------------------------
void RebinRagged::init() {
  declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "", Direction::Input), "input workspace");
  declareProperty(std::make_unique<WorkspaceProperty<>>("OutputWorkspace", "", Direction::Output), "output workspace");
 
  declareProperty(std::make_unique<ArrayProperty<double>>("XMin"), "minimum x values with NaN meaning no minimum");
  declareProperty(std::make_unique<ArrayProperty<double>>("XMax"), "maximum x values with NaN meaning no maximum");
  declareProperty(std::make_unique<ArrayProperty<double>>("Delta"), "step parameter for rebin");
  declareProperty("PreserveEvents", true, "False converts event workspaces to histograms");
  declareProperty("FullBinsOnly", false, "Omit the final bin if it's width is smaller than the step size");
}
 
std::map<std::string, std::string> RebinRagged::validateInputs() {
  std::map<std::string, std::string> errors;
 
  const std::vector<double> xmins = getProperty("XMin");
  const std::vector<double> xmaxs = getProperty("XMax");
  const std::vector<double> deltas = getProperty("Delta");
 
  const auto numMin = xmins.size();
  const auto numMax = xmaxs.size();
  const auto numDelta = deltas.size();
 
  if (std::any_of(deltas.cbegin(), deltas.cend(), [](double d) { return !std::isfinite(d); }))
    errors["Delta"] = "All must be finite";
  else if (std::any_of(deltas.cbegin(), deltas.cend(), [](double d) { return d == 0; }))
    errors["Delta"] = "All must be nonzero";
 
  MatrixWorkspace_sptr inputWS = getProperty("InputWorkspace");
 
  if (inputWS) {
    const auto histnumber = inputWS->getNumberHistograms();
 
    if (numDelta == 0)
      errors["Delta"] = "Must specify binning";
    else if (!(numDelta == 1 || numDelta == histnumber))
      errors["Delta"] =
          "Must specify for each spetra (" + std::to_string(numDelta) + "!=" + std::to_string(histnumber) + ")";
 
    if (numMin > 1 && numMin != histnumber)
      errors["XMin"] =
          "Must specify min for each spectra (" + std::to_string(numMin) + "!=" + std::to_string(histnumber) + ")";
 
    if (numMax > 1 && numMax != histnumber)
      errors["XMax"] =
          "Must specify max for each spectra (" + std::to_string(numMax) + "!=" + std::to_string(histnumber) + ")";
  } else
    errors["InputWorkspace"] = "InputWorkspace is not a MatrixWorkspace";
 
  return errors;
}
 
//----------------------------------------------------------------------------------------------
void RebinRagged::exec() {
  MatrixWorkspace_sptr inputWS = getProperty("InputWorkspace");
  MatrixWorkspace_sptr outputWS = getProperty("OutputWorkspace");
 
  bool preserveEvents = getProperty("PreserveEvents");
  bool fullBinsOnly = getProperty("FullBinsOnly");
 
  // Rebinning in-place
  bool inPlace = (inputWS == outputWS);
 
  // workspace independent determination of length
  const auto histnumber = static_cast<int>(inputWS->getNumberHistograms());
 
  std::vector<double> xmins = getProperty("XMin");
  std::vector<double> xmaxs = getProperty("XMax");
  std::vector<double> deltas = getProperty("Delta");
 
  if (use_simple_rebin(xmins, xmaxs, deltas)) {
    g_log.information("Using Rebin instead");
    auto rebin = createChildAlgorithm("Rebin", 0.0, 1.0);
    rebin->setProperty("InputWorkspace", inputWS);
    rebin->setProperty("PreserveEvents", preserveEvents);
    rebin->setProperty("FullBinsOnly", fullBinsOnly);
    const std::vector<double> params = {xmins[0], deltas[0], xmaxs[0]};
    rebin->setProperty("Params", params);
    rebin->execute();
 
    MatrixWorkspace_sptr output = rebin->getProperty("OutputWorkspace");
    setProperty("OutputWorkspace", output);
    return;
  }
 
  extend_value(histnumber, xmins);
  extend_value(histnumber, xmaxs);
  extend_value(histnumber, deltas);
 
  // replace NaN and infinity with X min/max
  for (int hist = 0; hist < histnumber; hist++) {
    const auto inX = inputWS->x(hist);
    if (!std::isfinite(xmins[hist]))
      xmins[hist] = inX.front();
    if (!std::isfinite(xmaxs[hist]))
      xmaxs[hist] = inX.back();
  }
 
  const bool dist = inputWS->isDistribution();
 
  // Now, determine if the input workspace is an EventWorkspace
  EventWorkspace_const_sptr eventInputWS = std::dynamic_pointer_cast<const EventWorkspace>(inputWS);
 
  if (eventInputWS) {
    //------- EventWorkspace as input -------------------------------------
    if (preserveEvents) {
      if (!inPlace) {
        outputWS = inputWS->clone();
      }
      auto eventOutputWS = std::dynamic_pointer_cast<EventWorkspace>(outputWS);
 
      for (int hist = 0; hist < histnumber; hist++) {
        auto xmin = xmins[hist];
        auto xmax = xmaxs[hist];
        const auto delta = deltas[hist];
 
        std::vector<double> xAxisTmp;
        VectorHelper::createAxisFromRebinParams({xmin, delta, xmax}, xAxisTmp, true, fullBinsOnly);
        HistogramData::BinEdges XValues_new(std::move(xAxisTmp));
        EventList &el = eventOutputWS->getSpectrum(hist);
        el.setHistogram(XValues_new);
      }
    } else {
      //--------- not preserving Events
      g_log.information() << "Creating a Workspace2D from the EventWorkspace " << eventInputWS->getName() << ".\n";
 
      outputWS = DataObjects::create<DataObjects::Workspace2D>(*inputWS);
 
      Progress prog(this, 0.0, 1.0, histnumber);
 
      // Go through all the histograms and set the data
      PARALLEL_FOR_IF(Kernel::threadSafe(*inputWS, *outputWS))
      for (int hist = 0; hist < histnumber; ++hist) {
        PARALLEL_START_INTERRUPT_REGION
        auto xmin = xmins[hist];
        auto xmax = xmaxs[hist];
        const auto delta = deltas[hist];
 
        // Get a const event list reference. eventInputWS->dataY() doesn't work.
        const EventList &el = eventInputWS->getSpectrum(hist);
 
        std::vector<double> xAxisTmp;
        VectorHelper::createAxisFromRebinParams({xmin, delta, xmax}, xAxisTmp, true, fullBinsOnly);
        HistogramData::BinEdges XValues_new(std::move(xAxisTmp));
 
        MantidVec y_data, e_data;
        // The EventList takes care of histogramming.
        el.generateHistogram(delta, XValues_new.rawData(), y_data, e_data);
 
        // Create and set the output histogram
        HistogramBuilder builder;
        builder.setX(XValues_new.rawData());
        builder.setY(y_data);
        builder.setE(e_data);
        builder.setDistribution(dist);
        outputWS->setHistogram(hist, builder.build());
 
        prog.report();
        PARALLEL_END_INTERRUPT_REGION
      }
      PARALLEL_CHECK_INTERRUPT_REGION
    }
  } // END ---- EventWorkspace
 
  else
 
  { //------- Workspace2D or other MatrixWorkspace ---------------------------
    const bool isHist = inputWS->isHistogramData();
 
    if (!isHist) {
      // convert input to histogram
      inputWS = inputWS->clone();
      for (int hist = 0; hist < histnumber; ++hist) {
        HistogramBuilder builder;
        builder.setX(inputWS->histogram(hist).binEdges().rawData());
        builder.setY(inputWS->readY(hist));
        builder.setE(inputWS->readE(hist));
        if (inputWS->hasDx(dist))
          builder.setDx(inputWS->readDx(hist));
        builder.setDistribution(dist);
        inputWS->setHistogram(hist, builder.build());
      }
    }
 
    // make output Workspace the same type as the input
    outputWS = DataObjects::create<API::HistoWorkspace>(*inputWS);
 
    Progress prog(this, 0.0, 1.0, histnumber);
 
    PARALLEL_FOR_IF(Kernel::threadSafe(*inputWS, *outputWS))
    for (int hist = 0; hist < histnumber; ++hist) {
      PARALLEL_START_INTERRUPT_REGION
      auto xmin = xmins[hist];
      auto xmax = xmaxs[hist];
      const auto delta = deltas[hist];
 
      std::vector<double> xAxisTmp;
      VectorHelper::createAxisFromRebinParams({xmin, delta, xmax}, xAxisTmp, true, fullBinsOnly);
      HistogramData::BinEdges XValues_new(std::move(xAxisTmp));
 
      outputWS->setHistogram(hist, HistogramData::rebin(inputWS->histogram(hist), XValues_new));
      prog.report();
      PARALLEL_END_INTERRUPT_REGION
    }
    PARALLEL_CHECK_INTERRUPT_REGION
    outputWS->setDistribution(dist);
 
    // Now propagate any masking correctly to the output workspace
    // More efficient to have this in a separate loop because
    // MatrixWorkspace::maskBins blocks multi-threading
    for (int hist = 0; hist < histnumber; ++hist) {
      if (inputWS->hasMaskedBins(hist)) // Does the current spectrum have any masked bins?
      {
        outputWS->setUnmaskedBins(hist);
        this->propagateMasks(inputWS, outputWS, hist);
      }
    }
 
    if (!isHist) {
      // convert output to point data
      for (int hist = 0; hist < histnumber; ++hist) {
        HistogramBuilder builder;
        builder.setX(outputWS->histogram(hist).points().rawData());
        builder.setY(outputWS->readY(hist));
        builder.setE(outputWS->readE(hist));
        if (outputWS->hasDx(hist))
          builder.setDx(outputWS->readDx(hist));
        builder.setDistribution(dist);
        outputWS->setHistogram(hist, builder.build());
      }
    }
  } // END ---- Workspace2D
 
  setProperty("OutputWorkspace", outputWS);
}
 
bool RebinRagged::use_simple_rebin(std::vector<double> xmins, std::vector<double> xmaxs, std::vector<double> deltas) {
  if (xmins.size() == 1 && xmaxs.size() == 1 && deltas.size() == 1)
    return true;
 
  if (xmins.size() == 0 || xmaxs.size() == 0 || deltas.size() == 0)
    return false;
 
  // is there (effectively) only one xmin?
  if (!std::equal(xmins.cbegin() + 1, xmins.cend(), xmins.cbegin()))
    return false;
 
  // is there (effectively) only one xmax?
  if (!std::equal(xmaxs.cbegin() + 1, xmaxs.cend(), xmaxs.cbegin()))
    return false;
 
  // is there (effectively) only one delta?
  if (!std::equal(deltas.cbegin() + 1, deltas.cend(), deltas.cbegin()))
    return false;
 
  // all of these point to 'just do rebin'
  return true;
}
 
void RebinRagged::extend_value(int histnumber, std::vector<double> &array) {
  if (array.size() == 0) {
    array.resize(histnumber, std::numeric_limits<double>::quiet_NaN());
  } else if (array.size() == 1) {
    array.resize(histnumber, array[0]);
  }
}
} // namespace Mantid::Algorithms