Mantid
Loading...
Searching...
No Matches
CrossCorrelate.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2008 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 {
44class MANTID_ALGORITHMS_DLL CrossCorrelate final : public API::Algorithm {
45public:
49 ~CrossCorrelate() override = default;
51 const std::string name() const override { return "CrossCorrelate"; }
53 const std::string summary() const override {
54 return "Cross-correlates a range of spectra against one reference spectra "
55 "in the same workspace.";
56 }
57
59 int version() const override { return (1); }
60 const std::vector<std::string> seeAlso() const override { return {"GetDetectorOffsets"}; }
62 const std::string category() const override { return "Arithmetic"; }
63
64private:
66 void init() override;
68 void exec() override;
72 spec2index_map::iterator index_map_it;
73
75 std::unique_ptr<API::Progress> m_progress = nullptr;
76};
77
78// Functor for vector sum
79
80} // namespace Algorithms
81} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Compute the cross correlation function for a range of spectra with respect to a reference spectrum.
spec2index_map::iterator index_map_it
Iterator for the spectra to index map.
int version() const override
Algorithm's version.
const std::string category() const override
Algorithm's category for identification.
CrossCorrelate()
(Empty) Constructor
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string name() const override
Algorithm's name.
~CrossCorrelate() override=default
Virtual destructor.
const std::string summary() const override
Summary of algorithms purpose.
spec2index_map index_map
Spectra to index map.
Helper class which provides the Collimation Length for SANS instruments.
std::unordered_map< specnum_t, size_t > spec2index_map
Map with key = spectrum number, value = workspace index.