FilterEvents.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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 +
#pragma once
 
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ISplittersWorkspace.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/SplittersWorkspace.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidDataObjects/TimeSplitter.h"
#include "MantidKernel/SplittingInterval.h"
#include "MantidKernel/TimeSeriesProperty.h"
 
namespace Mantid {
 
namespace Kernel {
class TimeROI; // forward declaration
}
 
namespace API {
class TimeAtSampleStrategy;
}
 
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL FilterEvents final : public API::Algorithm {
 
  enum TOFCorrectionType { NoneCorrect, CustomizedCorrect, DirectCorrect, ElasticCorrect, IndirectCorrect };
  enum EVENTFILTERSKIP { EventFilterSkipNoDet, EventFilterSkipNoDetTOFCorr };
 
public:
  FilterEvents();
 
  const std::string name() const override { return "FilterEvents"; }
  const std::string summary() const override {
    return "Filter events from an EventWorkspace to one or multiple target "
           "event workspaces according to a series of splitters.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override {
    return {"GenerateEventsFilter", "FilterByTime", "FilterByLogValue"};
  }
 
  const std::string category() const override { return "Events\\EventFiltering"; }
  std::map<std::string, std::string> validateInputs() override;
 
private:
  // Implement abstract Algorithm methods
  void init() override;
  // Implement abstract Algorithm methods
  void exec() override;
 
  void processAlgorithmProperties();
 
  void parseInputSplitters();
 
  void createOutputWorkspaces();
 
  void setupDetectorTOFCalibration();
 
  API::TimeAtSampleStrategy *setupElasticTOFCorrection() const;
 
  API::TimeAtSampleStrategy *setupDirectTOFCorrection() const;
 
  API::TimeAtSampleStrategy *setupIndirectTOFCorrection() const;
 
  void setupCustomizedTOFCorrection();
 
  void filterEvents(double progressamount);
 
  void examineEventWS();
 
  void groupOutputWorkspace();
 
  Kernel::TimeROI partialROI(const int &index);
 
  DataObjects::EventWorkspace_sptr m_eventWS;
  DataObjects::SplittersWorkspace_sptr m_splittersWorkspace;
  DataObjects::TableWorkspace_sptr m_splitterTableWorkspace;
  API::MatrixWorkspace_sptr m_matrixSplitterWS;
  DataObjects::TableWorkspace_sptr m_detCorrectWorkspace;
 
  DataObjects::TimeSplitter m_timeSplitter;
  std::set<int> m_targetWorkspaceIndexSet;
 
  std::map<int, DataObjects::EventWorkspace_sptr> m_outputWorkspacesMap;
  std::vector<std::string> m_wsNames;
 
  std::vector<double> m_detTofOffsets;
  std::vector<double> m_detTofFactors;
 
  bool m_filterByPulseTime;
 
  DataObjects::TableWorkspace_sptr m_informationWS;
  bool m_hasInfoWS;
 
  double m_progress;
 
  std::string m_outputWSNameBase;
 
  bool m_toGroupWS;
 
  std::vector<int64_t> m_vecSplitterTime;
  std::vector<int> m_vecSplitterGroup;
 
  TOFCorrectionType m_tofCorrType;
 
  EVENTFILTERSKIP m_specSkipType;
  std::vector<bool> m_vecSkip;
 
  // Flag to have relative time in splitters workspace
  bool m_isSplittersRelativeTime;
  // Absolute base time for relative times in splitters workspace
  Types::Core::DateAndTime m_filterStartTime;
};
 
} // namespace Algorithms
} // namespace Mantid