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 Algorithms {
47class MANTID_ALGORITHMS_DLL CorrectKiKf final : public API::Algorithm {
48public:
50 const std::string name() const override { return "CorrectKiKf"; }
52 const std::string summary() const override {
53 return "Performs k_i/k_f multiplication, in order to transform "
54 "differential scattering cross section into dynamic structure "
55 "factor.";
56 }
57
59 int version() const override { return 1; }
61 const std::string category() const override {
62 return "Inelastic\\Corrections;CorrectionFunctions\\SpecialCorrections";
63 }
64
65private:
66 // Overridden Algorithm methods
67 void init() override;
68 void exec() override;
69 void execEvent();
76 template <class T> void correctKiKfEventHelper(std::vector<T> &wevector, double efixed, const std::string &emodeStr);
77 void getEfixedFromParameterMap(double &Efi, int64_t i, const Mantid::API::SpectrumInfo &spectrumInfo,
79};
80
81} // namespace Algorithms
82} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
API::SpectrumInfo is an intermediate step towards a SpectrumInfo that is part of Instrument-2....
Definition: SpectrumInfo.h:53
Multiplies the workspace with k_i/k_f The initial workspace must have energy transfer units.
Definition: CorrectKiKf.h:47
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: CorrectKiKf.h:61
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: CorrectKiKf.h:50
const std::string summary() const override
Summary of algorithms purpose.
Definition: CorrectKiKf.h:52
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: CorrectKiKf.h:59
Helper class which provides the Collimation Length for SANS instruments.
Generate a tableworkspace to store the calibration results.