Mantid
Loading...
Searching...
No Matches
CorrectKiKf.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//----------------------------------------------------------------------
12#include "MantidAPI/Algorithm.h"
14#include "MantidAlgorithms/DllConfig.h"
15
16namespace Mantid {
17namespace Geometry {
18class ComponentInfo;
19}
20namespace Algorithms {
50class MANTID_ALGORITHMS_DLL CorrectKiKf final : public API::Algorithm {
51public:
53 const std::string name() const override { return "CorrectKiKf"; }
55 const std::string summary() const override {
56 return "Performs k_i/k_f multiplication, in order to transform "
57 "differential scattering cross section into dynamic structure "
58 "factor.";
59 }
60
62 int version() const override { return 1; }
64 const std::string category() const override {
65 return "Inelastic\\Corrections;CorrectionFunctions\\SpecialCorrections";
66 }
67
68private:
69 // Overridden Algorithm methods
70 void init() override;
71 void exec() override;
72 void execEvent();
79 template <class T> void correctKiKfEventHelper(std::vector<T> &wevector, double efixed, const std::string &emodeStr);
80 void getEfixedFromParameterMap(double &Efi, int64_t i, const Mantid::API::SpectrumInfo &spectrumInfo,
81 const Mantid::Geometry::ComponentInfo &componentInfo);
82};
83
84} // namespace Algorithms
85} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
API::SpectrumInfo is an intermediate step towards a SpectrumInfo that is part of Instrument-2....
Multiplies the workspace with k_i/k_f The initial workspace must have energy transfer units.
Definition CorrectKiKf.h:50
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition CorrectKiKf.h:64
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition CorrectKiKf.h:53
const std::string summary() const override
Summary of algorithms purpose.
Definition CorrectKiKf.h:55
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition CorrectKiKf.h:62
ComponentInfo : Provides a component centric view on to the instrument.
Helper class which provides the Collimation Length for SANS instruments.