RebinByTimeAtSample.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/RebinByTimeAtSample.h"
#include "MantidAlgorithms/TimeAtSampleStrategyElastic.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidKernel/Unit.h"
#include "MantidKernel/V3D.h"
#include "MantidKernel/VectorHelper.h"
 
#include <memory>
 
#include <algorithm>
#include <cmath>
 
namespace Mantid {
using namespace HistogramData;
 
namespace Algorithms {
using namespace Mantid::Kernel;
using namespace Mantid::API;
using namespace Mantid::DataObjects;
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(RebinByTimeAtSample)
 
//----------------------------------------------------------------------------------------------
 
 
int RebinByTimeAtSample::version() const { return 1; }
 
const std::string RebinByTimeAtSample::category() const { return "Transforms\\Rebin;Events\\EventFiltering"; }
 
const std::string RebinByTimeAtSample::summary() const {
  return "Rebins with an x-axis of relative time at sample for comparing event "
         "arrival time at the sample environment.";
}
 
const std::string RebinByTimeAtSample::name() const { return "RebinByTimeAtSample"; }
 
void RebinByTimeAtSample::doHistogramming(IEventWorkspace_sptr inWS, MatrixWorkspace_sptr outputWS,
                                          MantidVecPtr &XValues_new, MantidVec &OutXValues_scaled, Progress &prog) {
  const auto histnumber = static_cast<int>(inWS->getNumberHistograms());
 
  const double tofOffset = 0;
 
  TimeAtSampleStrategyElastic strategy(inWS);
 
  auto x = Kernel::make_cow<HistogramData::HistogramX>(OutXValues_scaled);
 
  // Go through all the histograms and set the data
  PARALLEL_FOR_IF(Kernel::threadSafe(*inWS, *outputWS))
  for (int i = 0; i < histnumber; ++i) {
    PARALLEL_START_INTERRUPT_REGION
 
    Correction correction = strategy.calculate(i);
 
    const double tofFactor = correction.factor;
 
    const auto &el = inWS->getSpectrum(i);
    MantidVec y_data, e_data;
    // The EventList takes care of histogramming.
    el.generateHistogramTimeAtSample(*XValues_new, y_data, e_data, tofFactor, tofOffset);
 
    // Set the X axis for each output histogram
    outputWS->setSharedX(i, x);
 
    // Copy the data over.
    outputWS->mutableY(i) = y_data;
    outputWS->mutableE(i) = e_data;
 
    // Report progress
    prog.report(name());
    PARALLEL_END_INTERRUPT_REGION
  }
  PARALLEL_CHECK_INTERRUPT_REGION
}
 
uint64_t RebinByTimeAtSample::getMaxX(Mantid::API::IEventWorkspace_sptr ws) const {
  return ws->getTimeAtSampleMax().totalNanoseconds();
}
 
uint64_t RebinByTimeAtSample::getMinX(Mantid::API::IEventWorkspace_sptr ws) const {
  return ws->getTimeAtSampleMin().totalNanoseconds();
}
 
} // namespace Algorithms
} // namespace Mantid