forked from npshub/mantid
-
Notifications
You must be signed in to change notification settings - Fork 0
/
PSIBackgroundSubtraction.h
45 lines (38 loc) · 1.95 KB
/
PSIBackgroundSubtraction.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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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
#include "MantidAPI/DataProcessorAlgorithm.h"
#include "MantidAPI/IFunction_fwd.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidMuon/DllConfig.h"
namespace Mantid {
namespace Muon {
class MANTID_MUON_DLL PSIBackgroundSubtraction : public API::DataProcessorAlgorithm {
public:
PSIBackgroundSubtraction() : API::DataProcessorAlgorithm() {}
const std::string name() const override { return "PSIBackgroundSubtraction"; }
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override { return {"Fit", "LoadPSIMuonBin"}; }
const std::string summary() const override { return "Removes the background from a loaded PSI workspace."; }
const std::string category() const override { return "Muon"; }
private:
void init() override;
void exec() override;
void calculateBackgroundUsingFit(API::MatrixWorkspace_sptr &inputWorkspace);
/// setup the child fit algorithm, can be overwritten by the tests with a
/// mock.
API::IAlgorithm_sptr setupFitAlgorithm(const std::string &wsName);
virtual std::tuple<double, double> calculateBackgroundFromFit(API::IAlgorithm_sptr &fit,
const std::pair<double, double> &range,
const int &workspaceIndex);
/// Perform validation of inputs to the algorithm
std::map<std::string, std::string> validateInputs() override;
API::IFunction_sptr getFunction() const;
std::pair<double, double> getRange(API::MatrixWorkspace const &inputWorkspace, const std::size_t &index) const;
};
} // namespace Muon
} // namespace Mantid