AnyShapeAbsorption.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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"
#include "MantidGeometry/Objects/CSGObject.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL AnyShapeAbsorption : public AbsorptionCorrection {
public:
  AnyShapeAbsorption();
  const std::string name() const override { return "AbsorptionCorrection"; }
 
  const std::vector<std::string> seeAlso() const override {
    return {"SetSampleMaterial",   "CreateSampleShape",     "DefineGaugeVolume",          "CylinderAbsorption",
            "FlatPlateAbsorption", "AnnularRingAbsorption", "CuboidGaugeVolumeAbsorption"};
  }
 
  const std::string summary() const override {
    return "Calculates an approximation of the attenuation due to absorption "
           "and single scattering in a generic sample shape. The sample shape "
           "can be defined by, e.g., the CreateSampleShape algorithm.\nNote "
           "that if your sample is of cuboid or cylinder geometry, you will "
           "get a more accurate result from the FlatPlateAbsorption or "
           "CylinderAbsorption algorithms respectively.";
  }
 
  int version() const override { return (1); }
 
private:
  void defineProperties() override;
  void retrieveProperties() override;
  std::string sampleXML() override;
  void initialiseCachedDistances() override;
  std::shared_ptr<const Geometry::IObject> constructGaugeVolume();
 
  double m_cubeSide; 
};
 
} // namespace Algorithms
} // namespace Mantid