Mantid
Loading...
Searching...
No Matches
AnnularRingAbsorption.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2014 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
10#include "MantidAlgorithms/DllConfig.h"
11namespace Mantid {
12//-----------------------------------------------------------------------------------------------
13// Forward declarations
14//-----------------------------------------------------------------------------------------------
15namespace Kernel {
16class Material;
17class V3D;
18} // namespace Kernel
19
20namespace Algorithms {
21
26class MANTID_ALGORITHMS_DLL AnnularRingAbsorption final : public API::Algorithm {
27public:
28 const std::string name() const override;
29 int version() const override;
30 const std::vector<std::string> seeAlso() const override { return {"AbsorptionCorrection"}; }
31 const std::string category() const override;
32 const std::string summary() const override;
33
34private:
35 void init() override;
36 void exec() override;
37
38 void attachSample(API::MatrixWorkspace_sptr &workspace);
39 void runCreateSampleShape(API::MatrixWorkspace_sptr &workspace);
40 std::string createSampleShapeXML(const Kernel::V3D &upAxis) const;
41 const std::string cylinderXML(const std::string &id, const Kernel::V3D &bottomCentre, const double radius,
42 const Kernel::V3D &axis, const double height) const;
43 void runSetSampleMaterial(API::MatrixWorkspace_sptr &workspace);
44 API::MatrixWorkspace_sptr runMonteCarloAbsorptionCorrection(const API::MatrixWorkspace_sptr &workspace);
45};
46
47} // namespace Algorithms
48} // namespace Mantid
double height
Definition: GetAllEi.cpp:155
IPeaksWorkspace_sptr workspace
Definition: IndexPeaks.cpp:114
double radius
Definition: Rasterize.cpp:31
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Constructs a hollow sample shape, defines material for the sample and runs the MonteCarloAbsorption a...
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
A material is defined as being composed of a given element, defined as a PhysicalConstants::NeutronAt...
Definition: Material.h:50
Class for 3D vectors.
Definition: V3D.h:34
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.