-
Notifications
You must be signed in to change notification settings - Fork 122
/
CuboidGaugeVolumeAbsorption.h
50 lines (43 loc) · 1.85 KB
/
CuboidGaugeVolumeAbsorption.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
// 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/FlatPlateAbsorption.h"
namespace Mantid {
namespace Algorithms {
/** Calculates attenuation due to absorption and scattering in a generic sample,
considering only the
scattering within a cuboid shaped 'gauge volume'.
This gauge volume will be an axis-aligned cuboid with its centre at the
samplePos point. The
sample object must have been previously defined and must fully enclose the
gauge volume.
@author Russell Taylor, Tessella
@date 1/11/2010
*/
class MANTID_ALGORITHMS_DLL CuboidGaugeVolumeAbsorption : public FlatPlateAbsorption {
public:
/// Algorithm's name
const std::string name() const override { return "CuboidGaugeVolumeAbsorption"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Calculates bin-by-bin correction factors for attenuation due to "
"absorption and (single) scattering within a cuboid shaped 'gauge "
"volume' of a generic sample. The sample shape can be defined by, "
"e.g., the CreateSampleShape algorithm.";
}
/// Algorithm's version
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override { return {"AbsorptionCorrection"}; }
private:
std::string sampleXML() override;
void initialiseCachedDistances() override;
};
} // namespace Algorithms
} // namespace Mantid