PaalmanPingsAbsorptionCorrection.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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/MatrixWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/Objects/IObject.h"
#include "MantidKernel/Material.h"
#include "MantidKernel/V3D.h"
 
namespace Mantid {
 
namespace API {
class Sample;
}
namespace Geometry {
class IDetector;
class IObject;
} // namespace Geometry
 
namespace Algorithms {
class MANTID_ALGORITHMS_DLL PaalmanPingsAbsorptionCorrection final : public API::Algorithm {
public:
  PaalmanPingsAbsorptionCorrection();
  const std::string name() const override { return "PaalmanPingsAbsorptionCorrection"; }
  const std::string category() const override { return "CorrectionFunctions\\AbsorptionCorrections"; }
  const std::string summary() const override {
    return "Calculates the attenuation due to absorption "
           "and single scattering in a generic sample shape for all "
           "Paalmin-pings terms.";
  }
 
  const std::vector<std::string> seeAlso() const override {
    return {"SetSampleMaterial", "AbsorptionCorrection", "ApplyPaalmanPingsCorrection",
            "PaalmanPingsMonteCarloAbsorption"};
  }
 
  int version() const override { return (1); }
 
private:
  void init() override;
  std::map<std::string, std::string> validateInputs() override;
  void exec() override;
 
  void retrieveBaseProperties();
  void constructSample(API::Sample &sample);
  void calculateDistances(const Geometry::IDetector &detector, std::vector<double> &sample_L2s,
                          std::vector<double> &sample_container_L2s, std::vector<double> &container_L2s,
                          std::vector<double> &container_sample_L2s) const;
  void doIntegration(double &integral, double &crossIntegral, const double linearCoefAbs,
                     const double linearCoefTotScatt, const std::vector<double> &elementVolumes,
                     const std::vector<double> &L1s, const std::vector<double> &L2s, const double linearCoefAbs2,
                     const double linearCoefTotScatt2, const std::vector<double> &L1s2, const std::vector<double> &L2s2,
                     const size_t startIndex, const size_t endIndex) const;
  void defineProperties();
  void retrieveProperties();
  void initialiseCachedDistances();
 
  API::MatrixWorkspace_sptr m_inputWS;                  
  const Geometry::IObject *m_sampleObject;              
  const Geometry::IObject *m_containerObject;           
  Kernel::V3D m_beamDirection;                          
  std::vector<double> m_sampleL1s,                      
      m_sample_containerL1s,                            
      m_sampleElementVolumes;                           
  std::vector<Kernel::V3D> m_sampleElementPositions;    
  size_t m_numSampleVolumeElements;                     
  double m_sampleVolume;                                
  std::vector<double> m_containerL1s,                   
      m_container_sampleL1s,                            
      m_containerElementVolumes;                        
  std::vector<Kernel::V3D> m_containerElementPositions; 
  size_t m_numContainerVolumeElements;                  
  double m_containerVolume;                             
  Kernel::Material m_material;
  Kernel::Material m_containerMaterial;
  double m_ampleLinearCoefTotScatt;     
  double m_containerLinearCoefTotScatt; 
  int64_t m_num_lambda;                 
  int64_t m_xStep; 
 
  std::shared_ptr<const Geometry::IObject> constructGaugeVolume();
  double m_cubeSideSample;    
  double m_cubeSideContainer; 
};
 
} // namespace Algorithms
} // namespace Mantid