SumEventsByLogValue.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidKernel/TimeSeriesProperty.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL SumEventsByLogValue final : public API::Algorithm {
public:
  const std::string name() const override { return "SumEventsByLogValue"; }
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"FilterByLogValue"}; }
  const std::string category() const override { return "Events"; }
  const std::string summary() const override {
    return "Produces a single spectrum workspace containing the "
           "total summed events in the workspace as a function of a specified "
           "log.";
  }
 
  std::map<std::string, std::string> validateInputs() override;
 
private:
  void init() override;
  void exec() override;
 
  void createTableOutput(const Kernel::TimeSeriesProperty<int> *log);
 
  template <typename T> void createBinnedOutput(const Kernel::TimeSeriesProperty<T> *log);
 
  void filterEventList(const API::IEventList &eventList, const int minVal, const int maxVal,
                       const Kernel::TimeSeriesProperty<int> *log, std::vector<int> &Y);
  void addMonitorCounts(const API::ITableWorkspace_sptr &outputWorkspace, const Kernel::TimeSeriesProperty<int> *log,
                        const int minVal, const int maxVal);
  std::vector<std::pair<std::string, const Kernel::ITimeSeriesProperty *>> getNumberSeriesLogs();
  double sumProtonCharge(const Kernel::TimeSeriesProperty<double> *protonChargeLog,
                         const Kernel::TimeSplitterType &filter);
 
  DataObjects::EventWorkspace_const_sptr m_inputWorkspace; 
  std::string m_logName;                                   
  std::vector<double> m_binningParams;                     
};
 
} // namespace Algorithms
} // namespace Mantid