Mantid
Loading...
Searching...
No Matches
CorrectToFile.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2009 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"
13#include "MantidAlgorithms/DllConfig.h"
14
15namespace Mantid {
16namespace Algorithms {
30class MANTID_ALGORITHMS_DLL CorrectToFile : public Mantid::API::Algorithm {
31public:
33 const std::string name() const override { return "CorrectToFile"; }
35 const std::string summary() const override { return "Correct data using a file in the LOQ RKH format"; }
36
38 int version() const override { return (1); }
40 const std::string category() const override { return "SANS;CorrectionFunctions"; }
41
42private:
45 static const double LOAD_TIME;
47 void init() override;
49 void exec() override;
51 API::MatrixWorkspace_sptr loadInFile(const std::string &corrFile);
53 void doWkspAlgebra(const API::MatrixWorkspace_sptr &lhs, const API::MatrixWorkspace_sptr &rhs,
54 const std::string &algName, API::MatrixWorkspace_sptr &result);
55};
56} // namespace Algorithms
57} // namespace Mantid
const std::vector< double > & rhs
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
const std::string summary() const override
Summary of algorithms purpose.
Definition: CorrectToFile.h:35
const std::string name() const override
Algorithm's name.
Definition: CorrectToFile.h:33
const std::string category() const override
Algorithm's category for identification.
Definition: CorrectToFile.h:40
int version() const override
Algorithm's version.
Definition: CorrectToFile.h:38
static const double LOAD_TIME
used for the progress bar: the, approximate, fraction of processing time that taken up with loading t...
Definition: CorrectToFile.h:45
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.