Mantid
Loading...
Searching...
No Matches
CuboidGaugeVolumeAbsorption.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
9//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
13
14namespace Mantid {
15namespace Algorithms {
28class MANTID_ALGORITHMS_DLL CuboidGaugeVolumeAbsorption : public FlatPlateAbsorption {
29public:
31 const std::string name() const override { return "CuboidGaugeVolumeAbsorption"; }
33 const std::string summary() const override {
34 return "Calculates bin-by-bin correction factors for attenuation due to "
35 "absorption and (single) scattering within a cuboid shaped 'gauge "
36 "volume' of a generic sample. The sample shape can be defined by, "
37 "e.g., the CreateSampleShape algorithm.";
38 }
39
41 int version() const override { return (1); }
42 const std::vector<std::string> seeAlso() const override { return {"AbsorptionCorrection"}; }
43
44private:
45 std::string sampleXML() override;
46 void initialiseCachedDistances() override;
47};
48
49} // namespace Algorithms
50} // namespace Mantid
Calculates attenuation due to absorption and scattering in a generic sample, considering only the sca...
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
int version() const override
Algorithm's version.
const std::string name() const override
Algorithm's name.
const std::string summary() const override
Summary of algorithms purpose.
Calculates attenuation due to absorption and scattering in a flat plate/slab sample.
Helper class which provides the Collimation Length for SANS instruments.