CalculateCountRate.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 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 "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL CalculateCountRate : public API::Algorithm {
public:
  virtual ~CalculateCountRate() = default;
  const std::string name() const override;
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"ChangePulsetime"}; }
  const std::string category() const override;
  const std::string summary() const override;
  bool normalizeCountRate() const;
  bool useLogDerivative() const;
  bool buildVisWS() const;
 
private:
  void init() override;
  void exec() override;
  // holder of the temporary log, used for normalization, binning source etc...
  std::unique_ptr<Kernel::TimeSeriesProperty<double>> m_tmpLogHolder;
  // diable log normalization
  void disableNormalization(const std::string &NormLogError);
 
protected: // for testing, actually private
  bool m_normalizeResult{false};
  Kernel::TimeSeriesProperty<double> const *m_pNormalizationLog{nullptr};
  int m_numLogSteps{200};
  bool m_rangeExplicit{false};
  bool m_useLogDerivative{false};
  double m_XRangeMin{0}, m_XRangeMax{0};
  Types::Core::DateAndTime m_TRangeMin{0}, m_TRangeMax{0};
  DataObjects::EventWorkspace_sptr m_workingWS;
 
  void setSourceWSandXRanges(DataObjects::EventWorkspace_sptr &InputWorkspace);
 
  void setOutLogParameters(const DataObjects::EventWorkspace_sptr &InputWorkspace);
 
  void calcRateLog(DataObjects::EventWorkspace_sptr &InputWorkspace, Kernel::TimeSeriesProperty<double> *const targLog);
 
  void checkAndInitVisWorkspace();
 
  void histogramEvents(const DataObjects::EventList &el, std::mutex *spectraLocks);
 
  void buildVisWSNormalization(std::vector<double> &normalization);
 
  bool m_doVis{false};
  DataObjects::Workspace2D_sptr m_visWs;
  // variables used in 2D histogramming of the visualization workspace
  double m_visX0, m_visDX, m_visT0, m_visDT, m_visTmax;
  // vector used in normalization of the visualization workspace
  std::vector<double> m_visNorm;
};
 
} // namespace Algorithms
} // namespace Mantid