VesuvioCalculateGammaBackground.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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 "MantidCurveFitting/DllConfig.h"
#include "MantidGeometry/IComponent.h"
#include "MantidGeometry/IDTypes.h"
 
#include <map>
 
#include <span>
 
namespace Mantid {
 
namespace Kernel {
class V3D;
}
 
namespace CurveFitting {
namespace Functions {
struct ResolutionParams;
}
namespace Algorithms {
//---------------------------------------------------------------------------
// Forward declarations
//---------------------------------------------------------------------------
struct DetectorParams;
 
class MANTID_CURVEFITTING_DLL VesuvioCalculateGammaBackground final : public API::Algorithm {
public:
  VesuvioCalculateGammaBackground();
  ~VesuvioCalculateGammaBackground() override;
 
  const std::string name() const override;
  const std::string summary() const override {
    return "Calculates the background due to gamma rays produced when neutrons "
           "are absorbed by shielding.";
  }
  const std::vector<std::string> seeAlso() const override { return {"VesuvioCorrections"}; }
 
  int version() const override;
  const std::string category() const override;
 
private:
  void init() override;
  void exec() override;
 
  struct FoilInfo {
    double thetaMin;
    double thetaMax;
    double lorentzWidth;
    double gaussWidth;
  };
 
  bool calculateBackground(size_t inputIndex, size_t outputIndex);
  void applyCorrection(const size_t inputIndex, const size_t outputIndex);
  void calculateSpectrumFromDetector(const size_t inputIndex, const size_t outputIndex);
  void calculateBackgroundFromFoils(const size_t inputIndex, const size_t outputIndex);
  void calculateBackgroundSingleFoil(std::vector<double> &ctfoil, const size_t wsIndex, const FoilInfo &foilInfo,
                                     const Kernel::V3D &detPos, const DetectorParams &detPar,
                                     const CurveFitting::Functions::ResolutionParams &detRes);
  std::vector<double> calculateTofSpectrum(std::span<double const> inSpectrum, std::vector<double> &tmpWork,
                                           const size_t wsIndex, const DetectorParams &detpar,
                                           const CurveFitting::Functions::ResolutionParams &respar);
 
  void retrieveInputs();
  void createOutputWorkspaces();
  void cacheInstrumentGeometry();
  std::pair<double, double> calculateThetaRange(const Geometry::IComponent_const_sptr &foilComp, const double radius,
                                                const unsigned int horizDir) const;
 
  API::MatrixWorkspace_const_sptr m_inputWS;
  std::map<size_t, size_t> m_indices;
  std::string m_profileFunction;
  size_t m_npeaks;
  std::set<specnum_t> m_reversed;
 
  Kernel::V3D m_samplePos;
  double m_l1;
  double m_foilRadius;
  double m_foilUpMin;
  double m_foilUpMax;
 
  std::vector<FoilInfo> m_foils0;
  std::vector<FoilInfo> m_foils1;
  API::MatrixWorkspace_sptr m_backgroundWS;
  API::MatrixWorkspace_sptr m_correctedWS;
 
  std::unique_ptr<API::Progress> m_progress = nullptr;
};
 
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid