DetectorEfficiencyCor.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/IDetector.h"
#include "MantidGeometry/Objects/IObject.h"
#include "MantidKernel/V3D.h"
 
#include <list>
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL DetectorEfficiencyCor final : public API::Algorithm {
public:
  DetectorEfficiencyCor();
  const std::string name() const override { return "DetectorEfficiencyCor"; }
  const std::string summary() const override {
    return "This algorithm adjusts the binned data in a workspace for detector "
           "efficiency, calculated from the neutrons' kinetic energy, the gas "
           "filled detector's geometry and gas pressure. The data are then "
           "multiplied by :math:`k_i/k_f`";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"He3TubeEfficiency", "DetectorEfficiencyCorUser"}; }
  const std::string category() const override {
    return "CorrectionFunctions\\EfficiencyCorrections;Inelastic\\Corrections";
  }
 
private:
  void retrieveProperties();
  void correctForEfficiency(int64_t spectraIn, const API::SpectrumInfo &spectrumInfo);
  double calculateOneOverK(double loBinBound, double uppBinBound) const;
  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 chebevApprox(double a, double b, const double exspansionCoefs[], double x) const;
  void logErrors(size_t totalNDetectors) const;
 
private:
  API::MatrixWorkspace_const_sptr m_inputWS;
  API::MatrixWorkspace_sptr m_outputWS;
  const Geometry::ParameterMap *m_paraMap;
 
  double m_Ei;
  double m_ki;
 
  std::map<const Geometry::IObject *, std::pair<double, Kernel::V3D>> m_shapeCache;
  Kernel::V3D m_samplePos;
  std::list<int64_t> m_spectraSkipped;
 
  // Implement abstract Algorithm methods
  void init() override;
  void exec() override;
};
 
} // namespace Algorithms
} // namespace Mantid