SortEvents.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 +
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAlgorithms/SortEvents.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/ListValidator.h"
 
namespace Mantid::Algorithms {
 
// Register the class into the algorithm factory
DECLARE_ALGORITHM(SortEvents)
 
using namespace Kernel;
using namespace API;
using DataObjects::EventWorkspace;
using DataObjects::EventWorkspace_const_sptr;
using DataObjects::EventWorkspace_sptr;
 
void SortEvents::init() {
  declareProperty(std::make_unique<WorkspaceProperty<EventWorkspace>>("InputWorkspace", "", Direction::InOut),
                  "EventWorkspace to be sorted.");
 
  std::vector<std::string> propOptions{"X Value", "Pulse Time", "Pulse Time + TOF"};
  declareProperty("SortBy", "X Value", std::make_shared<StringListValidator>(propOptions),
                  "How to sort the events:\n"
                  "  X Value: the x-position of the event in each pixel "
                  "(typically Time of Flight).\n"
                  "  Pulse Time: the wall-clock time of the pulse that "
                  "produced the event.");
}
 
void SortEvents::exec() {
  // Get the input workspace
  EventWorkspace_sptr eventW = getProperty("InputWorkspace");
  // And other properties
  std::string sortoption = getPropertyValue("SortBy");
 
  //------- EventWorkspace ---------------------------
  const size_t histnumber = eventW->getNumberHistograms();
 
  // Initialize progress reporting.
  Progress prog(this, 0.0, 1.0, histnumber);
 
  DataObjects::EventSortType sortType = DataObjects::TOF_SORT;
  if (sortoption == "Pulse Time")
    sortType = DataObjects::PULSETIME_SORT;
  else if (sortoption == "Pulse Time + TOF")
    sortType = DataObjects::PULSETIMETOF_SORT;
 
  // This runs the SortEvents algorithm in parallel
  eventW->sortAll(sortType, &prog);
}
 
} // namespace Mantid::Algorithms