CylinderAbsorption.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAlgorithms/AbsorptionCorrection.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL CylinderAbsorption : public AbsorptionCorrection {
public:
  CylinderAbsorption();
  const std::string name() const override { return "CylinderAbsorption"; }
  const std::string summary() const override {
    return "Calculates bin-by-bin correction factors for attenuation due to "
           "absorption and single scattering in a 'cylindrical' sample.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"AbsorptionCorrection"}; }
 
private:
  void defineProperties() override;
  void retrieveProperties() override;
  std::string sampleXML() override;
  void initialiseCachedDistances() override;
  void getShapeFromSample(const Geometry::IObject &sampleShape, bool updateHeight, bool updateRadius);
  std::map<std::string, std::string> validateInputs() override;
  Kernel::V3D m_cylAxis; 
  double m_cylHeight;    
  double m_cylRadius;    
  int m_numSlices;       
  int m_numAnnuli;       
  bool m_useSampleShape;
};
 
} // namespace Algorithms
} // namespace Mantid