Mantid
Loading...
Searching...
No Matches
CorelliCrossCorrelate.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"
12
13namespace Mantid {
14namespace Algorithms {
15
18class MANTID_ALGORITHMS_DLL CorelliCrossCorrelate final : public API::Algorithm {
19public:
20 const std::string name() const override { return "CorelliCrossCorrelate"; };
21 int version() const override { return 1; };
22 const std::string category() const override { return "Diffraction\\Calibration;Events"; };
23 const std::string summary() const override {
24 return "Cross-correlation calculation for the elastic signal from Corelli.";
25 };
26
27private:
28 std::map<std::string, std::string> validateInputs() override;
29 void init() override;
30 void exec() override;
31
35};
36
37} // namespace Algorithms
38} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
CorelliCrossCorrelate : TODO: DESCRIPTION.
const std::string category() const override
function to return a category of the algorithm.
DataObjects::EventWorkspace_sptr outputWS
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
DataObjects::EventWorkspace_const_sptr inputWS
Input workspace.
const std::string summary() const override
function returns a summary message that will be displayed in the default GUI, and in the help.
std::shared_ptr< const EventWorkspace > EventWorkspace_const_sptr
shared pointer to a const Workspace2D
std::shared_ptr< EventWorkspace > EventWorkspace_sptr
shared pointer to the EventWorkspace class
Helper class which provides the Collimation Length for SANS instruments.