He3TubeEfficiency.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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/SpectrumInfo.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidKernel/V3D.h"
 
namespace Mantid {
 
// forward declarations
namespace HistogramData {
class Points;
}
namespace Geometry {
class IDetector;
class IObject;
class ParameterMap;
} // namespace Geometry
 
namespace Algorithms {
class MANTID_ALGORITHMS_DLL He3TubeEfficiency final : public API::Algorithm {
public:
  He3TubeEfficiency();
 
  const std::string name() const override { return "He3TubeEfficiency"; }
  const std::string summary() const override { return "He3 tube efficiency correction."; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"DetectorEfficiencyCor"}; }
  const std::string category() const override { return "CorrectionFunctions\\EfficiencyCorrections"; }
 
private:
  // Implement abstract Algorithm methods
  void init() override;
  void exec() override;
  void execEvent();
 
  void computeEfficiencyCorrection(std::vector<double> &effCorrection, const HistogramData::Points &wavelength,
                                   const double expConstant, const double scale) const;
  void correctForEfficiency(std::size_t spectraIndex, const API::SpectrumInfo &spectrumInfo);
  void getDetectorGeometry(const Geometry::IDetector &det, double &detRadius, Kernel::V3D &detAxis);
  double distToSurface(const Kernel::V3D &start, const Geometry::IObject *shape) const;
  double detectorEfficiency(const double alpha, const double scale_factor = 1.0) const;
  void logErrors() const;
  double getParameter(const std::string &wsPropName, std::size_t currentIndex, const std::string &detPropName,
                      const Geometry::IDetector &idet);
  template <class T> void eventHelper(std::vector<T> &events, double expval);
  double calculateExponential(std::size_t spectraIndex, const Geometry::IDetector &idet);
 
  API::MatrixWorkspace_const_sptr m_inputWS;
  API::MatrixWorkspace_sptr m_outputWS;
  const Geometry::ParameterMap *m_paraMap;
  std::map<const Geometry::IObject *, std::pair<double, Kernel::V3D>> m_shapeCache;
  Kernel::V3D m_samplePos;
  std::vector<specnum_t> m_spectraSkipped;
  std::unique_ptr<API::Progress> m_progress;
};
 
} // namespace Algorithms
} // namespace Mantid